Struct Context

pub struct Context<'a> {
    pub pathspec: Search,
    pub stack: Stack,
    pub filter: Pipeline,
    pub should_interrupt: &'a AtomicBool,
}

The context for index_as_worktree()`.

Fields

pathspec: Search

The pathspec to limit the amount of paths that are checked. Can be empty to allow all paths.

Note that these are expected to have a common_prefix() according to the prefix of the repository to efficiently limit the scope of the paths we process.

stack: Stack

A stack pre-configured to allow accessing attributes for each entry, as required for filter and possibly pathspecs.

filter: Pipeline

A filter to be able to perform conversions from and to the worktree format.

It is needed to potentially refresh the index with data read from the worktree, which needs to be converted back to the form stored in Git.

Note that for this to be correct, the attribute stack must be configured correctly as well.

should_interrupt: &'a AtomicBool

A flag to query to learn if cancellation is requested.

Trait Implementations

impl<'a> Clone for Context<'a>

fn clone(&self) -> Context<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.