Struct mhgit::Status

pub struct Status {
    pub changed: Vec<Entry>,
    pub renamed: Vec<Entry>,
    pub untracked: Vec<String>,
    pub ignored: Vec<String>,
    // some fields omitted
}

Git status data.

use mhgit::Repository;

fn main() {
    let status = Repository::new().status().unwrap();
}

Fields

changed: Vec<Entry>

Changed entries

renamed: Vec<Entry>

Renamed/copied entries

untracked: Vec<String>

Untracked filenames

ignored: Vec<String>

Ignored filenames

Implementations

impl Status

pub fn new() -> Status

Return an empty status.

pub fn branch_oid(&self) -> &str

Object id (oid) of current commit.

pub fn branch_head(&self) -> &str

Head of current branch.

pub fn upstream_branch(&self) -> Option<&str>

Upstream branch, if set

pub fn upstream_behind(&self) -> Option<u32>

Number of commits upstream is behind.

pub fn upstream_ahead(&self) -> Option<u32>

Number of commits upstream is ahead.

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl Default for Status

fn default() -> Status

Returns the "default value" for a type.

impl Eq for Status

impl Hash for Status

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Status> for Status

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Status

impl StructuralPartialEq for Status

impl<'_> TryFrom<&'_ str> for Status

type Error = Error

The type returned in the event of a conversion error.

fn try_from(txt: &str) -> Result<Status, Self::Error>

Parse captured output text from git status