Skip to content

Commit

Permalink
Merge pull request #1124 from xtexx/clarify-doc
Browse files Browse the repository at this point in the history
docs: Document that pushurl_bytes returns null if no push url is set
  • Loading branch information
ehuss authored Feb 6, 2025
2 parents bc646ee + 09bb3a7 commit 7b7be43
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/remote.rs
Original file line number Diff line number Diff line change
Expand Up @@ -152,12 +152,14 @@ impl<'repo> Remote<'repo> {

/// Get the remote's pushurl.
///
/// Returns `None` if the pushurl is not valid utf-8
/// Returns `None` if the pushurl is not valid utf-8 or no special url for pushing is set.
pub fn pushurl(&self) -> Option<&str> {
self.pushurl_bytes().and_then(|s| str::from_utf8(s).ok())
}

/// Get the remote's pushurl as a byte array.
///
/// Returns `None` if no special url for pushing is set.
pub fn pushurl_bytes(&self) -> Option<&[u8]> {
unsafe { crate::opt_bytes(self, raw::git_remote_pushurl(&*self.raw)) }
}
Expand Down

0 comments on commit 7b7be43

Please sign in to comment.