Struct radicle_surf::Commit

pub struct Commit {
    pub id: Oid,
    pub author: Author,
    pub committer: Author,
    pub message: String,
    pub summary: String,
    pub parents: Vec<Oid>,
}

Commit is the metadata of a Git commit.

Fields

id: Oid

Object Id

author: Author

The author of the commit.

committer: Author

The actor who committed this commit.

message: String

The long form message of the commit.

summary: String

The summary message of the commit.

parents: Vec<Oid>

The parents of this commit.

Implementations

impl Commit

pub fn description(&self) -> &str

Returns the commit description text. This is the text after the one-line summary.

Trait Implementations

impl Clone for Commit

fn clone(&self) -> Commit

Returns a copy 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 Ord for Commit

fn cmp(&self, other: &Commit) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Commit

fn eq(&self, other: &Commit) -> 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 PartialOrd for Commit

fn partial_cmp(&self, other: &Commit) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ToCommit for Commit

type Error = Infallible

fn to_commit(self, _repo: &Repository) -> Result<Commit, Self::Error>

Converts to a commit in repo.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(commit: Commit<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Commit

impl StructuralPartialEq for Commit