gix_status::index_as_worktree

Struct Context

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

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§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Context<'a>

§

impl<'a> RefUnwindSafe for Context<'a>

§

impl<'a> Send for Context<'a>

§

impl<'a> Sync for Context<'a>

§

impl<'a> Unpin for Context<'a>

§

impl<'a> UnwindSafe for Context<'a>

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> 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.