Skip to main content

FileOperationOptions

Struct FileOperationOptions

pub struct FileOperationOptions {Show 16 fields
    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: Vec<String>,
    pub ignore_metadata: Vec<MetadataField>,
    pub strict: bool,
    pub force: bool,
    pub dry_run: bool,
    pub verbose: bool,
}

Expand description

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: Vec<String>

Source-relative path patterns ignored by copy and sync.

§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. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for FileOperationOptions

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

Formats the value using the given formatter. Read more

impl Default for FileOperationOptions

fn default() -> Self

Returns the “default value” for a type. Read more

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 ==.

1.0.0 (const: unstable) · Source§

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

Auto Trait Implementations§

impl Freeze for FileOperationOptions

impl RefUnwindSafe for FileOperationOptions

impl Send for FileOperationOptions

impl Sync for FileOperationOptions

impl Unpin for FileOperationOptions

impl UnsafeUnpin for FileOperationOptions

impl UnwindSafe for FileOperationOptions

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.