Struct WorkingTreeState 

pub struct WorkingTreeState {
    pub branch: Option<String>,
    pub head: Option<String>,
    pub upstream: Option<String>,
    pub ahead: usize,
    pub behind: usize,
    pub in_progress: Option<String>,
    pub changes: Vec<PathChange>,
}

What git says about the working tree right now.

use majordomus_cli::commit::WorkingTreeState;
let clean = WorkingTreeState::default();
assert!(clean.is_clean());
assert!(clean.staged().is_empty());

Fields

branch: Option<String>

The branch, or None when HEAD is detached.

head: Option<String>

HEAD’s full name, or None in a repository with no commits.

upstream: Option<String>

The upstream ref, when the branch has one.

ahead: usize

Commits this branch has that its upstream does not.

behind: usize

Commits the upstream has that this branch does not.

in_progress: Option<String>

A merge, rebase, cherry-pick or bisect in progress, when there is one.

changes: Vec<PathChange>

Every change, ordered by stage then path.

Implementations

impl WorkingTreeState

pub fn staged(&self) -> Vec<String>

The paths that would be in a commit made right now.

use majordomus_cli::commit::{ChangeStage, WorkingTreeState};
use majordomus_cli::commit::plan::PathChange;
let c = |p: &str, s| PathChange { path: p.into(), stage: s, status: "M.".into(), partial: false };
let tree = WorkingTreeState {
    changes: vec![c("a.rs", ChangeStage::Staged), c("b.rs", ChangeStage::Unstaged)],
    ..WorkingTreeState::default()
};
assert_eq!(tree.staged(), vec!["a.rs".to_string()]);
assert!(!tree.is_clean());

pub fn is_clean(&self) -> bool

Whether there is nothing to commit.

Trait Implementations

impl Clone for WorkingTreeState

fn clone(&self) -> WorkingTreeState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkingTreeState

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

Formats the value using the given formatter.

impl Default for WorkingTreeState

fn default() -> WorkingTreeState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WorkingTreeState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for WorkingTreeState

impl JsonSchema for WorkingTreeState

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for WorkingTreeState

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WorkingTreeState