Enum git_worktree::fs::cache::State

pub enum State {
    CreateDirectoryAndAttributesStack {
        unlink_on_collision: bool,
        test_mkdir_calls: usize,
        attributes: Attributes,
    },
    AttributesAndIgnoreStack {
        attributes: Attributes,
        ignore: Ignore,
    },
    IgnoreStack(Ignore),
}

Variants

CreateDirectoryAndAttributesStack

Fields

unlink_on_collision: bool

If there is a symlink or a file in our path, try to unlink it before creating the directory.

test_mkdir_calls: usize

Available on debug-assertions enabled only.

just for testing

attributes: Attributes

State to handle attribute information

Useful for checkout where directories need creation, but we need to access attributes as well.

AttributesAndIgnoreStack

Fields

attributes: Attributes

State to handle attribute information

ignore: Ignore

State to handle exclusion information

Used when adding files, requiring access to both attributes and ignore information, for example during add operations.

IgnoreStack(Ignore)

Used when providing worktree status information.

Implementations

impl State

pub fn for_checkout(unlink_on_collision: bool, attributes: Attributes) -> Self

Configure a state to be suitable for checking out files.

pub fn for_add(attributes: Attributes, ignore: Ignore) -> Self

Configure a state for adding files.

pub fn for_status(ignore: Ignore) -> Self

Configure a state for status retrieval.

impl State

pub fn build_attribute_list<'paths>(
    &self,
    index: &State,
    paths: &'paths PathStorageRef,
    case: Case
) -> Vec<(&'paths BStr, ObjectId)>

Returns a vec of tuples of relative index paths along with the best usable OID for either ignore, attribute files or both.

• ignores entries which aren’t blobs
• ignores ignore entries which are not skip-worktree
• within merges, picks ‘our’ stage both for ignore and attribute files.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.