Struct CopyOptions 

#[non_exhaustive]
pub struct CopyOptions { /* private fields */ }

Options controlling file, object, or tree copy operations.

Examples

use qubit_fs::copy::CopyOptions;
use qubit_fs::copy::ServerSidePreference;
use qubit_fs::metadata::FileSystemCapabilities;
let options = CopyOptions::default().with_server_side(ServerSidePreference::Require);
assert!(options.validate_against(FileSystemCapabilities::new()).is_err());

Implementations

impl CopyOptions

pub const fn with_mode(self, mode: CopyMode) -> Self

Returns a copy of these options with the source mode replaced.

pub const fn mode(&self) -> CopyMode

Returns the source interpretation mode.

pub const fn with_conflict(self, conflict: CopyConflictPolicy) -> Self

Returns a copy with the destination conflict policy replaced.

pub const fn conflict(&self) -> CopyConflictPolicy

Returns the destination conflict policy.

pub const fn with_preserve_metadata( self, preserve_metadata: MetadataPreservePolicy, ) -> Self

Returns a copy with the metadata preservation policy replaced.

pub const fn preserve_metadata(&self) -> MetadataPreservePolicy

Returns the metadata preservation policy.

pub const fn with_server_side(self, server_side: ServerSidePreference) -> Self

Returns a copy with the server-side preference replaced.

pub const fn server_side(&self) -> ServerSidePreference

Returns the server-side preference.

pub const fn with_symlink_policy(self, policy: SymlinkPolicy) -> Self

Returns a copy with the symbolic-link policy override replaced.

pub const fn symlink_policy_override(&self) -> Option<SymlinkPolicy>

Returns the optional symbolic-link policy override.

pub const fn with_create_parent(self, create: bool) -> Self

Returns a copy with parent creation replaced.

pub const fn create_parent(&self) -> bool

Returns whether missing destination parents are created.

pub const fn with_continue_on_error(self, continue_on_error: bool) -> Self

Returns a copy with continuation policy replaced.

pub const fn continue_on_error(&self) -> bool

Returns whether tree copy continues after per-entry failures.

pub const fn with_atomicity(self, atomicity: AtomicityRequirement) -> Self

Returns a copy with the atomicity requirement replaced.

pub const fn atomicity(&self) -> AtomicityRequirement

Returns the atomicity requirement.

pub const fn with_durability(self, durability: DurabilityRequirement) -> Self

Returns a copy with the durability requirement replaced.

pub const fn durability(&self) -> DurabilityRequirement

Returns the durability requirement.

pub const fn with_max_depth(self, max_depth: Option<usize>) -> Self

Returns a copy with the maximum tree depth replaced.

pub const fn max_depth(&self) -> Option<usize>

Returns the optional maximum tree depth.

pub const fn with_max_entries(self, max_entries: Option<usize>) -> Self

Returns a copy with the maximum source entry count replaced.

Some(0) rejects every copy because even a file-mode copy consumes one source entry. For tree copies, the limit applies to the aggregate of files, directories, symbolic links, objects, and prefixes.

pub const fn max_entries(&self) -> Option<usize>

Returns the optional maximum source entry count.

None leaves the entry count unbounded. The count includes every source resource represented in the completed CopyOutcome statistics, including directories and prefixes.

pub const fn with_max_bytes(self, max_bytes: Option<u64>) -> Self

Returns a copy with the maximum copied byte count replaced.

pub const fn max_bytes(&self) -> Option<u64>

Returns the optional maximum copied byte count.

pub const fn with_deadline(self, deadline: Option<Duration>) -> Self

Returns a copy with the maximum elapsed duration replaced.

pub const fn deadline(&self) -> Option<Duration>

Returns the optional maximum elapsed duration.

pub fn file() -> Self

Creates options for copying one file-like resource.

Returns

Copy options with mode set to CopyMode::File.

pub fn tree() -> Self

Creates options for copying a resource tree.

Returns

Copy options with mode set to CopyMode::Tree.

pub fn validate_against( &self, capabilities: FileSystemCapabilities, ) -> Result<(), FsError>

Validates required copy semantics before provider side effects.

Preferred server-side copy may fall back and report its actual method. Required server-side copy must fail this preflight when the configured filesystem does not guarantee it.

Errors

Returns FsErrorKind::RequirementNotMet with FileSystemCapability::ServerSideCopy when required server-side copy is unavailable.

Trait Implementations

impl Clone for CopyOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CopyOptions

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

Formats the value using the given formatter.

impl Default for CopyOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CopyOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CopyOptions