Struct FileOperationOptions 

pub struct FileOperationOptions {

    pub cwd: Option<PathBuf>,
    pub root: Option<PathBuf>,
    pub environment: EnvironmentInput,
    pub operation: FileOperationKind,
    pub sources: Vec<PathBuf>,
    pub target: Option<PathBuf>,
    pub required: bool,
    pub symlinks: Option<SymlinkMode>,
    pub compare: Option<SyncCompare>,
    pub delete: Option<bool>,
    pub ignore_metadata: Vec<MetadataField>,
    pub strict: bool,
    pub force: bool,
    pub dry_run: bool,
    pub verbose: bool,
}

Options for running one manual file operation command.

Fields

cwd: Option<PathBuf>

Directory from which the operation starts. Defaults to the process cwd.

root: Option<PathBuf>

Overrides the root checkout used as the source base.

environment: EnvironmentInput

Explicit environment input used for compatibility discovery and options.

operation: FileOperationKind

File operation kind to run.

sources: Vec<PathBuf>

Source paths resolved from the root checkout.

target: Option<PathBuf>

Optional target path resolved from the current worktree.

required: bool

Fails when a source is missing.

symlinks: Option<SymlinkMode>

How copy and sync should treat source symlinks.

compare: Option<SyncCompare>

Sync comparison mode.

delete: Option<bool>

Whether sync should delete target-only files.

ignore_metadata: Vec<MetadataField>

Metadata fields ignored by copy and sync.

strict: bool

Fails on stricter file-operation conflicts.

force: bool

Replaces existing file-operation targets where supported.

dry_run: bool

Prints planned work without changing files.

verbose: bool

Prints detailed file-operation actions instead of compact summaries.

Implementations

impl FileOperationOptions

pub fn copy(sources: Vec<PathBuf>) -> Self

Creates copy command options for the given sources.

pub fn symlink(sources: Vec<PathBuf>) -> Self

Creates symlink command options for the given sources.

pub fn sync(sources: Vec<PathBuf>) -> Self

Creates sync command options for the given sources.

Trait Implementations

impl Clone for FileOperationOptions

fn clone(&self) -> FileOperationOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileOperationOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FileOperationOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for FileOperationOptions

impl PartialEq for FileOperationOptions

fn eq(&self, other: &FileOperationOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FileOperationOptions