Showing the changes to git-object/src/commit.rs (1 of 12 files). Show all
Unified · Split
| @@ -1,28 +1,39 @@ | ||
| 1 | 1 | use crate::borrowed; |
| 2 | 2 | use bstr::{BStr, ByteSlice}; |
| 3 | 3 | |
| 4 | +/// An iterator over extra headers in [owned][crate::owned::Commit] and [borrowed][borrowed::Commit] commits. | |
| 4 | 5 | pub struct ExtraHeaders<I> { |
| 5 | 6 | inner: I, |
| 6 | 7 | } |
| 7 | 8 | |
| 9 | +/// Instantiation and convenience | |
| 8 | 10 | impl<'a, I> ExtraHeaders<I> |
| 9 | 11 | where |
| 10 | 12 | I: Iterator<Item = (&'a BStr, &'a BStr)>, |
| 11 | 13 | { |
| 14 | + /// Create a new instance from an iterator over tuples of (name, value) pairs. | |
| 12 | 15 | pub fn new(iter: I) -> Self { |
| 13 | 16 | ExtraHeaders { inner: iter } |
| 14 | 17 | } |
| 18 | + /// Find the _value_ of the _first_ header with the given `name`. | |
| 15 | 19 | pub fn find(mut self, name: &str) -> Option<&'a BStr> { |
| 16 | 20 | self.inner |
| 17 | 21 | .find_map(move |(k, v)| if k == name.as_bytes().as_bstr() { Some(v) } else { None }) |
| 18 | 22 | } |
| 23 | + /// Return an iterator over all _values_ of headers with the given `name`. | |
| 19 | 24 | pub fn find_all(self, name: &'a str) -> impl Iterator<Item = &'a BStr> { |
| 20 | 25 | self.inner |
| 21 | 26 | .filter_map(move |(k, v)| if k == name.as_bytes().as_bstr() { Some(v) } else { None }) |
| 22 | 27 | } |
| 28 | + /// Return an iterator over all git mergetags. | |
| 29 | + /// | |
| 30 | + /// A merge tag is a tag object embedded within the respective header field of a commit, making | |
| 31 | + /// it a child object of sorts. | |
| 23 | 32 | pub fn mergetags(self) -> impl Iterator<Item = Result<borrowed::Tag<'a>, borrowed::Error>> { |
| 24 | 33 | self.find_all("mergetag").map(|b| borrowed::Tag::from_bytes(b)) |
| 25 | 34 | } |
| 35 | + | |
| 36 | + /// Return the cryptographic signature provided by gpg/pgp verbatim | |
| 26 | 37 | pub fn pgp_signature(self) -> Option<&'a BStr> { |
| 27 | 38 | self.find("gpgsig") |
| 28 | 39 | } |