Struct git_object::CommitRef

pub struct CommitRef<'a> {
    pub tree: &'a BStr,
    pub parents: SmallVec<[&'a BStr; 1]>,
    pub author: SignatureRef<'a>,
    pub committer: SignatureRef<'a>,
    pub encoding: Option<&'a BStr>,
    pub message: &'a BStr,
    pub extra_headers: Vec<(&'a BStr, Cow<'a, BStr>)>,
}

A git commit parsed using from_bytes().

A commit encapsulates information about a point in time at which the state of the repository is recorded, usually after a change which is documented in the commit message.

Fields

tree: &'a BStr

HEX hash of tree object we point to. Usually 40 bytes long.

Use tree() to obtain a decoded version of it.

parents: SmallVec<[&'a BStr; 1]>

HEX hash of each parent commit. Empty for first commit in repository.

author: SignatureRef<'a>

Who wrote this commit. Name and email might contain whitespace and are not trimmed to ensure round-tripping.

Use the author() method to received a trimmed version of it.

committer: SignatureRef<'a>

Who committed this commit. Name and email might contain whitespace and are not trimmed to ensure round-tripping.

Use the committer() method to received a trimmed version of it.

This may be different from the author in case the author couldn’t write to the repository themselves and is commonly encountered with contributed commits.

encoding: Option<&'a BStr>

The name of the message encoding, otherwise UTF-8 should be assumed.

message: &'a BStr

The commit message documenting the change.

extra_headers: Vec<(&'a BStr, Cow<'a, BStr>)>

Extra header fields, in order of them being encountered, made accessible with the iterator returned by extra_headers().

Implementations

impl<'a> CommitRef<'a>

pub fn message_summary(&self) -> Cow<'a, BStr>

Return exactly the same message as MessageRef::summary().

pub fn message_trailers(&self) -> Trailers<'a>

Return an iterator over message trailers as obtained from the last paragraph of the commit message. May be empty.

impl<'a> CommitRef<'a>

pub fn from_bytes(data: &'a [u8]) -> Result<CommitRef<'a>, Error>

Deserialize a commit from the given data bytes while avoiding most allocations.

Examples found in repository

src/object/mod.rs (line 209)

    pub fn from_bytes(kind: Kind, data: &'a [u8]) -> Result<ObjectRef<'a>, crate::decode::Error> {
        Ok(match kind {
            Kind::Tree => ObjectRef::Tree(TreeRef::from_bytes(data)?),
            Kind::Blob => ObjectRef::Blob(BlobRef { data }),
            Kind::Commit => ObjectRef::Commit(CommitRef::from_bytes(data)?),
            Kind::Tag => ObjectRef::Tag(TagRef::from_bytes(data)?),
        })
    }

src/data.rs (line 19)

    pub fn decode(&self) -> Result<ObjectRef<'a>, crate::decode::Error> {
        Ok(match self.kind {
            Kind::Tree => ObjectRef::Tree(TreeRef::from_bytes(self.data)?),
            Kind::Blob => ObjectRef::Blob(BlobRef { data: self.data }),
            Kind::Commit => ObjectRef::Commit(CommitRef::from_bytes(self.data)?),
            Kind::Tag => ObjectRef::Tag(TagRef::from_bytes(self.data)?),
        })
    }

pub fn tree(&self) -> ObjectId

Return the tree fields hash digest.

Examples found in repository

src/commit/write.rs (line 57)

    fn write_to(&self, mut out: impl io::Write) -> io::Result<()> {
        encode::trusted_header_id(b"tree", &self.tree(), &mut out)?;
        for parent in self.parents() {
            encode::trusted_header_id(b"parent", &parent, &mut out)?;
        }
        encode::trusted_header_signature(b"author", &self.author, &mut out)?;
        encode::trusted_header_signature(b"committer", &self.committer, &mut out)?;
        if let Some(encoding) = self.encoding.as_ref() {
            encode::header_field(b"encoding", encoding, &mut out)?;
        }
        for (name, value) in &self.extra_headers {
            encode::header_field_multi_line(name, value, &mut out)?;
        }
        out.write_all(NL)?;
        out.write_all(self.message)
    }

    fn kind(&self) -> Kind {
        Kind::Commit
    }

    fn size(&self) -> usize {
        let hash_in_hex = self.tree().kind().len_in_hex();
        b"tree".len() + 1 /* space */ + hash_in_hex + 1 /* nl */
            + self.parents.iter().count() * (b"parent".len() + 1 /* space */ + hash_in_hex + 1 /* nl */)
            + b"author".len() + 1 /* space */ + self.author.size() + 1 /* nl */
            + b"committer".len() + 1 /* space */ + self.committer.size() + 1 /* nl */
            + self
                .encoding
                .as_ref()
                .map(|e| b"encoding".len() + 1 /* space */ + e.len() + 1 /* nl */)
                .unwrap_or(0)
            + self
                .extra_headers
                .iter()
                .map(|(name, value)| {
                    // each header *value* is preceded by a space and followed by a newline
                    name.len() + value.split_str("\n").map(|s| s.len() + 2).sum::<usize>()
                })
                .sum::<usize>()
            + 1 /* nl */
            + self.message.len()
    }

pub fn parents(&self) -> impl Iterator<Item = ObjectId> + '_

Returns an iterator of parent object ids

Examples found in repository

src/commit/write.rs (line 58)

    fn write_to(&self, mut out: impl io::Write) -> io::Result<()> {
        encode::trusted_header_id(b"tree", &self.tree(), &mut out)?;
        for parent in self.parents() {
            encode::trusted_header_id(b"parent", &parent, &mut out)?;
        }
        encode::trusted_header_signature(b"author", &self.author, &mut out)?;
        encode::trusted_header_signature(b"committer", &self.committer, &mut out)?;
        if let Some(encoding) = self.encoding.as_ref() {
            encode::header_field(b"encoding", encoding, &mut out)?;
        }
        for (name, value) in &self.extra_headers {
            encode::header_field_multi_line(name, value, &mut out)?;
        }
        out.write_all(NL)?;
        out.write_all(self.message)
    }

pub fn extra_headers(
    &self
) -> ExtraHeaders<impl Iterator<Item = (&BStr, &BStr)>>

Returns a convenient iterator over all extra headers.

pub fn author(&self) -> SignatureRef<'a>

Return the author, with whitespace trimmed.

This is different from the author field which may contain whitespace.

pub fn committer(&self) -> SignatureRef<'a>

Return the committer, with whitespace trimmed.

This is different from the committer field which may contain whitespace.

pub fn message(&self) -> MessageRef<'a>

Returns a partially parsed message from which more information can be derived.

pub fn time(&self) -> Time

Returns the time at which this commit was created.

Trait Implementations

impl<'a> Clone for CommitRef<'a>

fn clone(&self) -> CommitRef<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for CommitRef<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for CommitRef<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CommitRef<'_>> for Commit

fn from(other: CommitRef<'_>) -> Commit

Converts to this type from the input type.

impl<'a> From<CommitRef<'a>> for ObjectRef<'a>

fn from(v: CommitRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for CommitRef<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for CommitRef<'a>

fn cmp(&self, other: &CommitRef<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'a> PartialEq<CommitRef<'a>> for CommitRef<'a>

fn eq(&self, other: &CommitRef<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd<CommitRef<'a>> for CommitRef<'a>

fn partial_cmp(&self, other: &CommitRef<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Serialize for CommitRef<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<ObjectRef<'a>> for CommitRef<'a>

type Error = ObjectRef<'a>

The type returned in the event of a conversion error.

fn try_from(value: ObjectRef<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> WriteTo for CommitRef<'a>

fn write_to(&self, out: impl Write) -> Result<()>

Serializes this instance to out in the git serialization format.

fn kind(&self) -> Kind

Returns the type of this object.

fn size(&self) -> usize

Returns the size of this object’s representation (the amount of data which would be written by write_to).

fn loose_header(&self) -> SmallVec<[u8; 28]>

Returns a loose object header based on the object’s data

impl<'a> Eq for CommitRef<'a>

impl<'a> StructuralEq for CommitRef<'a>

impl<'a> StructuralPartialEq for CommitRef<'a>