Skip to main content

CloneCapability

Enum CloneCapability 

Source
pub enum CloneCapability {
    None,
    WholeFile,
    Range,
}
Expand description

What kind of zero-copy extent sharing — reflinks — the backend can express. Returned by Filesystem::clone_capability.

Reflinks let a destination file (or a range of it) point at the same physical extents as a source, with copy-on-write semantics on the next write to either side. The on-disk encoding differs per backend (XFS refcount-btree, APFS clone records, Btrfs shared extents), so the trait surface offers two operations and a capability gate, with sensible byte-copy fallbacks for backends that can’t share extents natively.

Variants§

§

None

No extent sharing. clone_file falls back to a stream-copy (semantically equivalent, just not zero-copy); clone_range returns crate::Error::Unsupported.

§

WholeFile

Whole-file clone only — the backend can share every extent of the source into the destination as one atomic operation (e.g. APFS file-clone records). Sub-file ranges aren’t individually shareable, so clone_range still errors Unsupported unless the range exactly covers the whole file.

§

Range

Arbitrary range clone — clone_range works for any allocation- unit-aligned (src_off, dst_off, len) triple. XFS reflink, Btrfs BTRFS_IOC_CLONE_RANGE, and FICLONERANGE in general.

Implementations§

Source§

impl CloneCapability

Source

pub fn shares_extents(self) -> bool

True for CloneCapability::WholeFile or CloneCapability::Range. clone_file is guaranteed not to byte-copy in this case.

Source

pub fn supports_range(self) -> bool

True only for CloneCapability::Range — i.e. sub-file clone_range calls will succeed (assuming alignment etc.).

Trait Implementations§

Source§

impl Clone for CloneCapability

Source§

fn clone(&self) -> CloneCapability

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
Source§

impl Debug for CloneCapability

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for CloneCapability

Source§

fn eq(&self, other: &CloneCapability) -> 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.
Source§

impl Copy for CloneCapability

Source§

impl Eq for CloneCapability

Source§

impl StructuralPartialEq for CloneCapability

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.