Struct Commit 

pub struct Commit {
    pub tree: ObjectId,
    pub parents: SmallVec<[ObjectId; 1]>,
    pub author: Signature,
    pub committer: Signature,
    pub encoding: Option<BString>,
    pub message: BString,
    pub extra_headers: Vec<(BString, BString)>,
}

A mutable git commit, representing an annotated state of a working tree along with a reference to its historical commits.

Fields

tree: ObjectId

The hash of recorded working tree state.

parents: SmallVec<[ObjectId; 1]>

Hash of each parent commit. Empty for the first commit in repository.

author: Signature

Who wrote this commit.

committer: Signature

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<BString>

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

message: BString

The commit message documenting the change.

extra_headers: Vec<(BString, BString)>

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

Implementations

impl Commit

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

Returns a convenient iterator over all extra headers.

impl Commit

pub fn sign(self, options: Options) -> Result<Commit>

Available on crate feature signature only.

Return this commit with its active signature replaced by a newly created one according to options.

Unsuccessful signer exits provide program, exit_status, stdout, stderr, and, when available, exit_code according to the external program runtime failure schema.

Trait Implementations

impl Clone for Commit

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Commit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Commit

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Commit

impl From<Commit> for Object

fn from(v: Commit) -> Self

Converts to this type from the input type.

impl Hash for Commit

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 Ord for Commit

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Commit

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Commit

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Commit

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Commit

impl TryFrom<CommitRef<'_>> for Commit

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Object> for Commit

type Error = Object

The type returned in the event of a conversion error.

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

Performs the conversion.

impl WriteTo for Commit

fn write_to(&self, out: &mut dyn 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) -> u64

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