Struct gix_worktree_state::checkout::Options
source · pub struct Options {
pub fs: Capabilities,
pub validate: Options,
pub thread_limit: Option<usize>,
pub destination_is_initially_empty: bool,
pub overwrite_existing: bool,
pub keep_going: bool,
pub stat_options: Options,
pub attributes: Attributes,
pub filters: Pipeline,
pub filter_process_delay: Delay,
}
Expand description
Options to further configure the checkout operation.
Fields§
§fs: Capabilities
capabilities of the file system
validate: Options
Options to configure how to validate path components.
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.
stat_options: Options
Control how stat comparisons are made when checking if a file is fresh.
attributes: Attributes
A stack of attributes to use with the filesystem cache to use as driver for filters.
filters: Pipeline
The filter pipeline to use for applying mandatory filters before writing to the worktree.
filter_process_delay: Delay
Control how long-running processes may use the ‘delay’ capability.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Options
impl RefUnwindSafe for Options
impl Send for Options
impl Sync for Options
impl Unpin for Options
impl UnwindSafe for Options
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)