Struct SnapshotOptions

pub struct SnapshotOptions<'a> {
    pub base_ignores: Arc<GitIgnoreFile>,
    pub fsmonitor_settings: FsmonitorSettings,
    pub progress: Option<&'a SnapshotProgress<'a>>,
    pub start_tracking_matcher: &'a dyn Matcher,
    pub max_new_file_size: u64,
    pub conflict_marker_style: ConflictMarkerStyle,
}

Options used when snapshotting the working copy. Some of them may be ignored by some WorkingCopy implementations.

Fields

base_ignores: Arc<GitIgnoreFile>

The .gitignores to use while snapshotting. The typically come from the user’s configured patterns combined with per-repo patterns.

fsmonitor_settings: FsmonitorSettings

The fsmonitor (e.g. Watchman) to use, if any.

progress: Option<&'a SnapshotProgress<'a>>

A callback for the UI to display progress.

start_tracking_matcher: &'a dyn Matcher

For new files that are not already tracked, start tracking them if they match this.

max_new_file_size: u64

The size of the largest file that should be allowed to become tracked (already tracked files are always snapshotted). If there are larger files in the working copy, then LockedWorkingCopy::snapshot() may (depending on implementation) return SnapshotError::NewFileTooLarge.

conflict_marker_style: ConflictMarkerStyle

Expected conflict marker style for checking for changed files.

Implementations

impl SnapshotOptions<'_>

pub fn empty_for_test() -> Self

Create an instance for use in tests.

Trait Implementations

impl<'a> Clone for SnapshotOptions<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.