Struct FileOperation 

pub struct FileOperation {

    pub operation: FileOperationKind,
    pub source: PathBuf,
    pub target: PathBuf,
    pub source_path: PathBuf,
    pub target_path: PathBuf,
    pub required: bool,
    pub compare: Option<SyncCompare>,
    pub delete: Option<bool>,
    pub symlinks: Option<SymlinkMode>,
    pub include: Vec<String>,
    pub ignore: Vec<String>,
    pub ignore_metadata: Vec<MetadataField>,
    pub declaration: SourceSpan,
}

A normalized file operation.

Fields

operation: FileOperationKind

File operation kind.

source: PathBuf

Declared source path.

target: PathBuf

Declared target path.

source_path: PathBuf

Source path resolved from the root checkout.

target_path: PathBuf

Target path resolved from the current worktree.

required: bool

Whether a missing source should fail validation.

compare: Option<SyncCompare>

Sync comparison mode.

delete: Option<bool>

Whether sync should delete target-only files.

symlinks: Option<SymlinkMode>

How copy and sync should treat source symlinks.

include: Vec<String>

Source-relative path patterns that narrow copy and sync directory traversal to matching source paths. Empty means no include filtering.

ignore: Vec<String>

Source-relative path patterns ignored by copy and sync.

ignore_metadata: Vec<MetadataField>

Metadata fields ignored by copy and sync.

declaration: SourceSpan

Source location for the operation declaration.

Implementations

impl FileOperation

pub fn from_manual_options( context: &Worktree, options: ManualFileOperationOptions, ) -> Result<Vec<Self>>

Builds normalized manual file operation specs for an action plan.

This applies the same target derivation and option validation used by treeboot copy, treeboot symlink, and treeboot sync.

Errors

Returns an error when the manual operation has no sources, when an option is not valid for the selected operation kind, or when a target cannot be derived for an absolute source.

Trait Implementations

impl Clone for FileOperation

fn clone(&self) -> FileOperation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileOperation

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

Formats the value using the given formatter.

impl Eq for FileOperation

impl PartialEq for FileOperation

fn eq(&self, other: &FileOperation) -> 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 Serialize for FileOperation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileOperation