Struct Commit 

pub struct Commit {
    pub id: ObjectHash,
    pub tree_id: ObjectHash,
    pub parent_commit_ids: Vec<ObjectHash>,
    pub author: Signature,
    pub committer: Signature,
    pub message: String,
}

The Commit struct is used to represent a commit object.

• The tree object SHA-1/SHA-256 hashpoints to the top level tree for this commit, which reflects the complete state of the repository at the time of the commit. The tree object in turn points to blobs and subtrees which represent the files in the repository.
• The parent commit SHAs allow Git to construct a linked list of commits and build the full commit history. By chaining together commits in this fashion, Git is able to represent the entire history of a repository with a single commit object at its root.
• The author and committer fields contain the name, email address, timestamp and timezone.
• The message field contains the commit message, which maybe include signed or DCO.

Fields

id: ObjectHash

tree_id: ObjectHash

parent_commit_ids: Vec<ObjectHash>

author: Signature

committer: Signature

message: String

Implementations

impl Commit

pub fn new( author: Signature, committer: Signature, tree_id: ObjectHash, parent_commit_ids: Vec<ObjectHash>, message: &str, ) -> Commit

pub fn from_tree_id( tree_id: ObjectHash, parent_commit_ids: Vec<ObjectHash>, message: &str, ) -> Commit

Creates a new commit object from a tree ID and a list of parent commit IDs. This function generates the author and committer signatures using the current time and a fixed email address. It also sets the commit message to the provided string.

Arguments

• tree_id: The SHA1/ SHA-256 hash of the tree object that this commit points to.
• parent_commit_ids: A vector of SHA1/ SHA-256 hashes of the parent commits.
• message: A string containing the commit message.

Returns

A new Commit object with the specified tree ID, parent commit IDs, and commit message. The author and committer signatures are generated using the current time and a fixed email address.

pub fn format_message(&self) -> String

Formats the commit message by extracting the first meaningful line.

If the message contains a PGP signature, it returns the first non-empty line after the signature block. Otherwise, it returns the first non-empty line in the message. If no such line exists, it returns the original message.

Trait Implementations

impl Archive for Commit

where ObjectHash: Archive, Vec<ObjectHash>: Archive, Signature: Archive, String: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedCommit

The archived representation of this type.

type Resolver = CommitResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for Commit

fn clone(&self) -> Commit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Commit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Commit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<Commit, __D> for Archived<Commit>

where ObjectHash: Archive, <ObjectHash as Archive>::Archived: Deserialize<ObjectHash, __D>, Vec<ObjectHash>: Archive, <Vec<ObjectHash> as Archive>::Archived: Deserialize<Vec<ObjectHash>, __D>, Signature: Archive, <Signature as Archive>::Archived: Deserialize<Signature, __D>, String: Archive, <String as Archive>::Archived: Deserialize<String, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<Commit, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Display for Commit

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

Formats the value using the given formatter.

impl From<Commit> for Entry

fn from(value: Commit) -> Self

Converts to this type from the input type.

impl ObjectTrait for Commit

fn to_data(&self) -> Result<Vec<u8>, GitError>

Git-Internals-Git-Objects

fn from_bytes(data: &[u8], hash: ObjectHash) -> Result<Self, GitError>

where Self: Sized,

Creates a new object from a byte slice.

fn get_type(&self) -> ObjectType

Returns the type of the object.

fn get_size(&self) -> usize

fn from_buf_read<R: BufRead>(read: &mut ReadBoxed<R>, size: usize) -> Self

where Self: Sized,

Generate a new Object from a ReadBoxed<BufRead>. the input size,is only for new a vec with directive space allocation the input data stream and output object should be plain base object .

fn object_hash(&self) -> Result<ObjectHash, GitError>

impl PartialEq for Commit

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<__S: Fallible + ?Sized> Serialize<__S> for Commit

where ObjectHash: Serialize<__S>, Vec<ObjectHash>: Serialize<__S>, Signature: Serialize<__S>, String: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for Commit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Commit