Struct CommitData

pub struct CommitData<Tree, Parent> { /* private fields */ }

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

Implementations

impl CommitData<Oid, Oid>

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

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

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

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

impl<Tree, Parent> CommitData<Tree, Parent>

pub fn new<P, I, T>( tree: Tree, parents: P, author: Author, committer: Author, headers: Headers, message: String, trailers: I, ) -> CommitData<Tree, Parent>

where P: IntoIterator<Item = Parent>, I: IntoIterator<Item = T>, OwnedTrailer: From<T>,

pub fn tree(&self) -> &Tree

The tree this commit points to.

pub fn parents(&self) -> impl Iterator<Item = Parent>

where Parent: Clone,

The parents 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> + 'a

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>

pub fn map_tree<U, E, F>(self, f: F) -> Result<CommitData<U, Parent>, E>

where F: FnOnce(Tree) -> Result<U, E>,

Convert the CommitData::tree into a value of type U. The conversion function f can be fallible.

For example, map_tree can be used to turn raw tree data into an Oid by writing it to a repository.

pub fn map_parents<U, E, F>(self, f: F) -> Result<CommitData<Tree, U>, E>

where F: FnMut(Parent) -> Result<U, E>,

Convert the CommitData::parents into a vector containing values of type U. The conversion function f can be fallible.

For example, map_parents can be used to resolve the Oids to their respective git2::Commits.

Trait Implementations

impl<Tree, Parent> Debug for CommitData<Tree, Parent>

where Tree: Debug, Parent: Debug,

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

Formats the value using the given formatter.

impl FromStr for CommitData<Oid, Oid>

type Err = Parse

The associated error which can be returned from parsing.

fn from_str( buffer: &str, ) -> Result<CommitData<Oid, Oid>, <CommitData<Oid, Oid> as FromStr>::Err>

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

impl ToString for CommitData<Oid, Oid>

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFrom<&[u8]> for CommitData<Oid, Oid>

type Error = Parse

The type returned in the event of a conversion error.

fn try_from( data: &[u8], ) -> Result<CommitData<Oid, Oid>, <CommitData<Oid, Oid> as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl TryFrom<Buf> for CommitData<Oid, Oid>

type Error = Parse

The type returned in the event of a conversion error.

fn try_from( value: Buf, ) -> Result<CommitData<Oid, Oid>, <CommitData<Oid, Oid> as TryFrom<Buf>>::Error>

Performs the conversion.