Struct git_commit::Commit

pub struct Commit { /* private fields */ }

A git commit in its object description form, i.e. the output of git cat-file for a commit object.

Implementations

impl Commit

pub fn new<T>(
    tree: Oid,
    parents: Vec<Oid>,
    author: Author,
    committer: Author,
    headers: Headers,
    message: String,
    trailers: T
) -> Selfwhere
    T: IntoIterator<Item = OwnedTrailer>,

pub fn read(repo: &Repository, oid: Oid) -> Result<Self, Read>

Read the Commit from the repo that is expected to be found at oid.

pub fn write(&self, repo: &Repository) -> Result<Oid, Error>

Write the given Commit to the repo. The resulting Oid is the identifier for this commit.

pub fn tree(&self) -> Oid

The tree Oid this commit points to.

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

The parent Oids of this commit.

pub fn author(&self) -> &Author

The author of this commit, i.e. the header corresponding to author.

pub fn committer(&self) -> &Author

The committer of this commit, i.e. the header corresponding to committer.

pub fn message(&self) -> &str

The message body of this commit.

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

The Signatures found in this commit, i.e. the headers corresponding to gpgsig.

pub fn headers(&self) -> impl Iterator<Item = (&str, &str)>

The Headers found in this commit.

Note: these do not include tree, parent, author, and committer.

pub fn values<'a>(&'a self, name: &'a str) -> impl Iterator<Item = &'a str> + '_

Iterate over the Headers values that match the provided name.

pub fn push_header(&mut self, name: &str, value: &str)

Push a header to the end of the headers section.

pub fn trailers(&self) -> impl Iterator<Item = &OwnedTrailer>

Trait Implementations

impl Debug for Commit

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

Formats the value using the given formatter.

impl FromStr for Commit

type Err = Parse

The associated error which can be returned from parsing.

fn from_str(buffer: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl ToString for Commit

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFrom<&[u8]> for Commit

type Error = Parse

The type returned in the event of a conversion error.

fn try_from(data: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Buf> for Commit

type Error = Parse

The type returned in the event of a conversion error.

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

Performs the conversion.