Enum Status

pub enum Status {
    Pruned,
    Tracked,
    Ignored(Kind),
    Untracked,
}

The kind of entry as obtained from a directory.

Variants

Pruned

The entry was removed from the walk due to its other properties, like Property or PathspecMatch

Note that entries flagged as DotGit directory will always be considered Pruned, but if they are also ignored, in delete mode, they will be considered Ignored instead. This way, it’s easier to remove them while they will not be available for any interactions in read-only mode.

Tracked

The entry is tracked in Git.

Ignored(Kind)

The entry is ignored as per .gitignore files and their rules.

If this is a directory, then its entire contents is ignored. Otherwise, possibly due to configuration, individual ignored files are listed.

Untracked

The entry is not tracked by git yet, it was not found in the index.

If it’s a directory, the entire directory contents is untracked.

Implementations

impl Status

pub fn is_pruned(&self) -> bool

Return true if this status is considered pruned. A pruned entry is typically hidden from view due to a pathspec.

pub fn can_recurse( &self, file_type: Option<Kind>, pathspec_match: Option<PathspecMatch>, for_deletion: Option<ForDeletionMode>, worktree_root_is_repository: bool, ) -> bool

Return true if file_type is a directory on disk and isn’t ignored, and is not a repository. This implements the default rules of git status, which is good for a minimal traversal through tracked and non-ignored portions of a worktree. for_deletion is used to determine if recursion into a directory is allowed even though it otherwise wouldn’t be. If worktree_root_is_repository is true, then this status is part of the root of an iteration, and the corresponding worktree root is a repository itself. This typically happens for submodules. In this case, recursion rules are relaxed to allow traversing submodule worktrees.

Use pathspec_match to determine if a pathspec matches in any way, affecting the decision to recurse.

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 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Status

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

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

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

impl Eq for Status

impl StructuralPartialEq for Status