Struct git_repository::easy::Commit

pub struct Commit<'repo> {
    pub id: ObjectId,
    pub data: Vec<u8>,
    /* private fields */
}

A decoded commit object with access to its owning repository.

Please note that the limitations described in Object apply here as well.

Fields

id: ObjectId

The id of the commit

data: Vec<u8>

The fully decoded commit data

Implementations

impl<'repo> Commit<'repo>

pub fn message(&self) -> Result<MessageRef<'_>, Error>

Parse the commits message into a MessageRef, after decoding the entire commit object.

pub fn message_raw(&self) -> Result<&BStr, Error>

Decode the entire commit object in full and return the raw message bytes.

pub fn decode(&self) -> Result<CommitRef<'_>, Error>

Decode the entire commit object and return it for accessing all commit information.

Note that the returned commit object doesn’t make object lookup easy but should be used for successive calls to string-ish information to avoid decoding the object unnecessarily.

pub fn tree(&self) -> Result<Tree<'repo>, Error>

Parse the commit and return the the tree object it points to.

pub fn tree_id(&self) -> Option<ObjectId>

Parse the commit and return the the tree id it points to.

Trait Implementations

impl<'a> Drop for Commit<'a>

fn drop(&mut self)

Executes the destructor for this type.

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

type Error = Object<'repo>

The type returned in the event of a conversion error.

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

Performs the conversion.