Skip to main content

Commit

Struct Commit 

Source
pub struct Commit {
    pub tree: ObjectId,
    pub parents: Vec<ObjectId>,
    pub author: Vec<u8>,
    pub committer: Vec<u8>,
    pub encoding: Option<Vec<u8>>,
    pub message: Vec<u8>,
}
Expand description

A parsed, canonical representation of the commit headers this crate understands.

Commit preserves tree, parent, author, committer, encoding, and message bytes. It intentionally does not retain unknown headers, continuation blocks such as gpgsig, mergetags, or their original ordering. Use EncodedObject when commit object bytes or object ids must be preserved exactly.

Fields§

§tree: ObjectId§parents: Vec<ObjectId>§author: Vec<u8>§committer: Vec<u8>§encoding: Option<Vec<u8>>§message: Vec<u8>

Implementations§

Source§

impl Commit

Source

pub fn parse(format: ObjectFormat, bytes: &[u8]) -> Result<Self>

Parse a commit into the canonical typed representation.

Unknown headers and continuation records are accepted but not retained. Use EncodedObject for byte-exact commit preservation.

Source

pub fn parse_ref<'a>( format: ObjectFormat, bytes: &'a [u8], ) -> Result<CommitRef<'a>>

Source

pub fn write(&self) -> Vec<u8>

Serialize the canonical typed commit representation.

The output contains only the fields represented by Commit; it is not intended to reproduce raw input bytes that contained unknown headers, signatures, or mergetags.

Source

pub fn author_signature(&self) -> Option<Signature>

Parse the raw author line into a typed Signature parse-view, or None if the stored bytes are not a well-formed git identity.

This is a read-only lens: it does not touch the raw author bytes, which remain the source of truth for Commit::write. The returned signature re-serializes byte-identically to author (see Signature::to_ident_bytes).

Source

pub fn committer_signature(&self) -> Option<Signature>

Parse the raw committer line into a typed Signature parse-view, or None if the stored bytes are not a well-formed git identity. Read-only over the raw bytes, exactly like Commit::author_signature.

Trait Implementations§

Source§

impl Clone for Commit

Source§

fn clone(&self) -> Commit

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Commit

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Commit

Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl PartialEq for Commit

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Commit

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.