Struct git_object::immutable::commit::Commit

pub struct Commit<'a> {
    pub tree: &'a BStr,
    pub parents: SmallVec<[&'a BStr; 2]>,
    pub author: Signature<'a>,
    pub committer: Signature<'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; 2]>

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

author: Signature<'a>

Who wrote this commit.

committer: Signature<'a>

Who committed this commit.

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> Commit<'a>

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

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

pub fn tree(&self) -> ObjectId

Return the tree fields hash digest.

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

Returns an iterator of parent object ids

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

Returns a convenient iterator over all extra headers.

Trait Implementations

impl<'a> Clone for Commit<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Commit<'a>

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl<'a> Eq for Commit<'a>

impl From<Commit<'_>> for Commit

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

Performs the conversion.

impl<'a> From<Commit<'a>> for Object<'a>

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

Performs the conversion.

impl<'a> Hash for Commit<'a>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Commit<'a>

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

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'a> PartialEq<Commit<'a>> for Commit<'a>

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

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

fn ne(&self, other: &Commit<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<Commit<'a>> for Commit<'a>

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 Commit<'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> StructuralEq for Commit<'a>

impl<'a> StructuralPartialEq for Commit<'a>

impl<'a> TryFrom<Object<'a>> for Commit<'a>

type Error = Object<'a>

The type returned in the event of a conversion error.

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

Performs the conversion.