Struct git_repository::worktree::index::checkout::Options

pub struct Options {
    pub fs: Capabilities,
    pub thread_limit: Option<usize>,
    pub destination_is_initially_empty: bool,
    pub overwrite_existing: bool,
    pub keep_going: bool,
    pub trust_ctime: bool,
    pub check_stat: bool,
    pub attribute_globals: MatchGroup<Attributes>,
}

Fields

fs: Capabilities

capabilities of the file system

thread_limit: Option<usize>

If set, don’t use more than this amount of threads. Otherwise, usually use as many threads as there are logical cores. A value of 0 is interpreted as no-limit

destination_is_initially_empty: bool

If true, we assume no file to exist in the target directory, and want exclusive access to it. This should be enabled when cloning to avoid checks for freshness of files. This also enables detection of collisions based on whether or not exclusive file creation succeeds or fails.

overwrite_existing: bool

If true, default false, worktree entries on disk will be overwritten with content from the index even if they appear to be changed. When creating directories that clash with existing worktree entries, these will try to delete the existing entry. This is similar in behaviour as git checkout --force.

keep_going: bool

If true, default false, try to checkout as much as possible and don’t abort on first error which isn’t due to a conflict. The checkout operation will never fail, but count the encountered errors instead along with their paths.

trust_ctime: bool

If true, a files creation time is taken into consideration when checking if a file changed. Can be set to false in case other tools alter the creation time in ways that interfere with our operation.

Default true.

check_stat: bool

If true, all stat fields will be used when checking for up-to-date’ness of the entry. Otherwise nano-second parts of mtime and ctime,uid, gid, inode and device number will not be used, leaving only the whole-second part of ctime and mtime and the file size to be checked.

Default true.

attribute_globals: MatchGroup<Attributes>

A group of attribute patterns that are applied globally, i.e. aren’t rooted within the repository itself.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.