Struct Outcome

pub struct Outcome {
    pub entries_to_process: usize,
    pub entries_processed: usize,
    pub entries_skipped_by_common_prefix: usize,
    pub entries_skipped_by_pathspec: usize,
    pub entries_skipped_by_entry_flags: usize,
    pub symlink_metadata_calls: usize,
    pub entries_to_update: usize,
    pub racy_clean: usize,
    pub worktree_bytes: u64,
    pub worktree_files_read: usize,
    pub odb_bytes: u64,
    pub odb_objects_read: usize,
}

Provide additional information collected during the runtime of index_as_worktree().

Fields

entries_to_process: usize

The total amount of entries that is to be processed.

entries_processed: usize

The amount of entries we actually processed. If this isn’t the entire set, the operation was interrupted.

entries_skipped_by_common_prefix: usize

The amount of entries we didn’t even traverse (and thus update with stat) due to a common prefix in pathspecs. This is similar to the current working directory.

entries_skipped_by_pathspec: usize

The amount of entries that were skipped due to exclusion by pathspecs.

entries_skipped_by_entry_flags: usize

The amount of entries that were skipped as the entry flag indicated this.

symlink_metadata_calls: usize

The amount of times we queried symlink-metadata for a file on disk.

entries_to_update: usize

The amount of entries whose stats would need to be updated as its modification couldn’t be determined without an expensive calculation.

With these updates, this calculation will be avoided next time the status runs. Note that the stat updates are delegated to the caller.

racy_clean: usize

The amount of entries that were considered racy-clean - they will need thorough checking to see if they are truly clean, i.e. didn’t change.

worktree_bytes: u64

The amount of bytes read from the worktree in order to determine if an entry changed, across all files.

worktree_files_read: usize

The amount of files read in full from the worktree (and into memory).

odb_bytes: u64

The amount of bytes read from the object database in order to determine if an entry changed, across all objects.

odb_objects_read: usize

The amount of objects read from the object database.

Implementations

impl Outcome

pub fn skipped(&self) -> usize

The total amount of skipped entries, i.e. those that weren’t processed at all.

Trait Implementations

impl Clone for Outcome

fn clone(&self) -> Outcome

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Outcome

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

Formats the value using the given formatter.

impl Default for Outcome

fn default() -> Outcome

Returns the “default value” for a type.

impl Ord for Outcome

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

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

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

impl StructuralPartialEq for Outcome