Struct GitStatus 

pub struct GitStatus { /* private fields */ }

Combined status metadata.

Implementations

impl GitStatus

pub const fn new() -> GitStatus

Creates a clean status metadata value.

pub const fn with_index(self, index: GitIndexStatus) -> GitStatus

Sets the index-side status.

pub const fn with_worktree(self, worktree: GitWorktreeStatus) -> GitStatus

Sets the worktree-side status.

pub const fn with_conflict(self, conflict: GitConflictStatus) -> GitStatus

Sets conflict status metadata.

pub const fn with_change(self, change: GitFileChange) -> GitStatus

Sets file-change metadata.

pub const fn index(&self) -> GitIndexStatus

Returns index-side status.

pub const fn worktree(&self) -> GitWorktreeStatus

Returns worktree-side status.

pub const fn conflict(&self) -> Option<GitConflictStatus>

Returns conflict status metadata when present.

pub const fn change(&self) -> Option<GitFileChange>

Returns file-change metadata when present.

pub const fn is_clean(&self) -> bool

Returns true when the status metadata is clean.

pub fn porcelain_code(&self) -> String

Returns the two-character porcelain status code.

pub fn from_porcelain_code( value: &str, ) -> Result<GitStatus, GitStatusParseError>

Creates status metadata from a two-character porcelain code.

Errors

Returns GitStatusParseError when the code is not exactly two characters or contains unsupported status characters.

Trait Implementations

impl Clone for GitStatus

fn clone(&self) -> GitStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitStatus

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

Formats the value using the given formatter.

impl Default for GitStatus

fn default() -> GitStatus

Returns the “default value” for a type.

impl Hash for GitStatus

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GitStatus

fn cmp(&self, other: &GitStatus) -> 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,

Restrict a value to a certain interval.

impl PartialEq for GitStatus

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

fn partial_cmp(&self, other: &GitStatus) -> 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 Copy for GitStatus

impl Eq for GitStatus

impl StructuralPartialEq for GitStatus