Skip to main content

StatusModel

Struct StatusModel 

Source
pub struct StatusModel {
    pub head: HeadState,
    pub head_tree: Option<ObjectId>,
    pub state: WtStatusState,
    pub index: Index,
    pub staged: Vec<DiffEntry>,
    pub unstaged: Vec<DiffEntry>,
    pub untracked: Vec<String>,
    pub ignored: Vec<String>,
    pub stash_count: usize,
    pub index_sparse_on_disk: bool,
    pub sparse_directory_prefixes: Vec<Vec<u8>>,
}
Expand description

The computed result of git status: everything the renderers need, with no presentation applied.

Fields mirror what the CLI’s format_porcelain_v2, format_short, and format_long read today, so a renderer can be a pure function of this model plus the user’s chosen output format.

Fields§

§head: HeadState

The resolved HEAD (branch, detached, or unborn).

§head_tree: Option<ObjectId>

Tree OID of the HEAD commit, or None on an unborn branch.

§state: WtStatusState

In-progress operation state (merge, rebase, cherry-pick, bisect, …).

§index: Index

The loaded index, with sparse-directory placeholders expanded — the same index the renderers query for per-stage entries.

§staged: Vec<DiffEntry>

Staged changes: the index-vs-HEAD-tree diff.

§unstaged: Vec<DiffEntry>

Unstaged changes: the index-vs-worktree diff.

§untracked: Vec<String>

Untracked paths (subject to StatusOptions::untracked).

§ignored: Vec<String>

Ignored paths (subject to StatusOptions::ignored).

§stash_count: usize

Number of stash entries (for the optional stash footer / --show-stash).

§index_sparse_on_disk: bool

Whether the on-disk index used the sparse-directory format.

§sparse_directory_prefixes: Vec<Vec<u8>>

Sparse-directory prefixes present in the on-disk index, if any.

Trait Implementations§

Source§

impl Clone for StatusModel

Source§

fn clone(&self) -> StatusModel

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StatusModel

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.