Struct CommitData

Source

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

Expand description

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

Implementations§

Source §

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

Source

pub fn new<P, I, T>( tree: Tree, parents: P, author: Author, committer: Author, headers: Headers, message: String, trailers: I, ) -> Self
where P: IntoIterator<Item = Parent>, I: IntoIterator<Item = T>, OwnedTrailer: From<T>,

Source

pub fn tree(&self) -> &Tree

The tree this commit points to.

Source

pub fn parents(&self) -> impl Iterator<Item = Parent> + '_
where Parent: Clone,

The parents of this commit.

Source

pub fn author(&self) -> &Author

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

Source

pub fn committer(&self) -> &Author

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

Source

pub fn message(&self) -> &str

The message body of this commit.

Source

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

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

Source

pub fn strip_signatures(self) -> Self

Source

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.

Source

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.

Source

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

Push a header to the end of the headers section.

Source

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

Source

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.

Source

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, this can be used to resolve the object identifiers to their respective full commits.

Source §

impl<Tree, Parent> CommitData<Tree, Parent>
where Tree: FromStr, Parent: FromStr, Tree::Err: Error + Send + Sync + 'static, Parent::Err: Error + Send + Sync + 'static,

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self, ParseError>

Parse a CommitData from its raw git object bytes.

This is the inverse of the fmt::Display implementation. The bytes are expected to be valid UTF-8 and in the standard git commit object format produced by git cat-file -p <commit>.

Trailers are detected by scanning the last paragraph of the message body (the section after the final blank line). If every non-empty line in that paragraph is a valid Token: value pair, those lines are parsed as trailers and stored separately; otherwise the whole body is kept as the message with no trailers.