Struct git_object::commit::ExtraHeaders

pub struct ExtraHeaders<I> { /* private fields */ }

An iterator over extra headers in owned and borrowed commits.

Implementations

impl<'a, I> ExtraHeaders<I>where
    I: Iterator<Item = (&'a BStr, &'a BStr)>,

Instantiation and convenience.

pub fn new(iter: I) -> Self

Create a new instance from an iterator over tuples of (name, value) pairs.

Examples found in repository

src/commit/mod.rs (line 48)

    pub fn extra_headers(&self) -> crate::commit::ExtraHeaders<impl Iterator<Item = (&BStr, &BStr)>> {
        crate::commit::ExtraHeaders::new(self.extra_headers.iter().map(|(k, v)| (*k, v.as_ref())))
    }

    /// Return the author, with whitespace trimmed.
    ///
    /// This is different from the `author` field which may contain whitespace.
    pub fn author(&self) -> git_actor::SignatureRef<'a> {
        self.author.trim()
    }

    /// Return the committer, with whitespace trimmed.
    ///
    /// This is different from the `committer` field which may contain whitespace.
    pub fn committer(&self) -> git_actor::SignatureRef<'a> {
        self.committer.trim()
    }

    /// Returns a partially parsed message from which more information can be derived.
    pub fn message(&self) -> MessageRef<'a> {
        MessageRef::from_bytes(self.message)
    }

    /// Returns the time at which this commit was created.
    pub fn time(&self) -> git_actor::Time {
        self.committer.time
    }
}

impl Commit {
    /// Returns a convenient iterator over all extra headers.
    pub fn extra_headers(&self) -> ExtraHeaders<impl Iterator<Item = (&BStr, &BStr)>> {
        ExtraHeaders::new(self.extra_headers.iter().map(|(k, v)| (k.as_bstr(), v.as_bstr())))
    }

pub fn find(self, name: &str) -> Option<&'a BStr>

Find the value of the first header with the given name.

Examples found in repository

src/commit/mod.rs (line 117)

    pub fn pgp_signature(self) -> Option<&'a BStr> {
        self.find("gpgsig")
    }

pub fn find_all(self, name: &'a str) -> impl Iterator<Item = &'a BStr>

Return an iterator over all values of headers with the given name.

Examples found in repository

src/commit/mod.rs (line 112)

    pub fn mergetags(self) -> impl Iterator<Item = Result<TagRef<'a>, crate::decode::Error>> {
        self.find_all("mergetag").map(|b| TagRef::from_bytes(b))
    }

pub fn mergetags(self) -> impl Iterator<Item = Result<TagRef<'a>, Error>>

Return an iterator over all git mergetags.

A merge tag is a tag object embedded within the respective header field of a commit, making it a child object of sorts.

pub fn pgp_signature(self) -> Option<&'a BStr>

Return the cryptographic signature provided by gpg/pgp verbatim.