Enum CleanRefusalKind 

pub enum CleanRefusalKind {
    OperationInProgress(&'static str),
    Unreadable,
    NotPlain,
    StagedChange,
    FileChanged,
    StatStale,
    Racy,
    Untracked,
}

What: Which kind of state kept a worktree from being proven clean. Why: Callers decide by kind, never by the words of the reason: the snapshot rung restores a worktree whose only trouble is an ordinary change, and refuses every state a restore cannot be proven to undo; the sentence for the person is chosen by kind.

In TS you’d write (pseudocode):

type CleanRefusalKind = { kind: 'operation-in-progress'; name: string } | { kind: 'unreadable' } | { kind: 'not-plain' }
  | { kind: 'staged-change' } | { kind: 'file-changed' } | { kind: 'stat-stale' } | { kind: 'racy' } | { kind: 'untracked' };

Variants

OperationInProgress(&'static str)

A merge, cherry-pick, revert, bisect, rebase, sequencer or index.lock mark exists; the name is the mark’s.

Unreadable

The index, the object database, the configuration or Git itself cannot be read in the way the checks need.

NotPlain

An index or tree entry of a kind a restore cannot be proven to undo: unmerged, intent-to-add, skip-worktree, assume-unchanged, or a submodule.

StagedChange

The index differs from the tree of HEAD: a staged addition, deletion, change or rename.

FileChanged

A tracked file is missing, changed its type or executable bit, or differs in content.

StatStale

A tracked file’s size, times or inode differ from its entry, so it probably changed.

Racy

A tracked file is as new as the index, so its stat fields prove nothing.

Untracked

Git lists an untracked file that no ignore rule covers.

Implementations

impl CleanRefusalKind

pub fn restorable(self) -> bool

Whether a reset to a commit can undo the state: only ordinary changes, not an operation in progress or a state Git keeps outside the tree and the files.

Trait Implementations

impl Clone for CleanRefusalKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CleanRefusalKind

impl Debug for CleanRefusalKind

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

Formats the value using the given formatter.

impl Eq for CleanRefusalKind

impl PartialEq for CleanRefusalKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CleanRefusalKind