Skip to main content

FilesystemOperation

Enum FilesystemOperation 

Source
pub enum FilesystemOperation {
    CreateDirectory {
        path: AbsolutePath,
        parents: bool,
    },
    PutFile {
        path: AbsolutePath,
        content_ref: ContentRef,
        behavior: DestinationBehavior,
        expected_revision_no: Option<RevisionNo>,
    },
    DeletePath {
        path: AbsolutePath,
        behavior: DeleteDirectoryBehavior,
        expected_inode_id: Option<InodeId>,
    },
    MovePath {
        from_path: AbsolutePath,
        to_path: AbsolutePath,
        behavior: DestinationBehavior,
    },
    CopyPath {
        from_path: AbsolutePath,
        to_path: AbsolutePath,
        behavior: DestinationBehavior,
    },
    Undelete {
        inode_id: InodeId,
        deletion_seq: ChangeSeq,
        path: Option<AbsolutePath>,
    },
    RestoreRevision {
        path: AbsolutePath,
        source_revision_no: RevisionNo,
    },
    UpdateAttributes {
        path: AbsolutePath,
        set: BTreeMap<AttributeKey, AttributeValue>,
        remove: Vec<AttributeKey>,
        expected_inode_id: Option<InodeId>,
        expected_attributes_revision_no: Option<AttributeRevisionNo>,
    },
}
Expand description

One path-oriented filesystem operation.

Unknown fields are rejected because concurrency guards are optional. A misspelled guard must fail decoding instead of silently becoming None and allowing an unguarded write. Any future fieldless variant must use empty braces so serde also rejects unexpected fields for that variant.

Variants§

§

CreateDirectory

Create one directory.

Fields

§path: AbsolutePath

Absolute destination path, rejected when invalid or already bound.

§parents: bool

Also create missing ancestor directories (the same auto-create put_file performs). The final component must still be new.

§

PutFile

Create or replace one file with an already-durable content ref.

Fields

§path: AbsolutePath

Absolute destination path; missing ancestors are created automatically.

§content_ref: ContentRef

Immutable bytes that must be covered by a valid preparation proof.

§behavior: DestinationBehavior

Whether an existing file may receive a new revision instead of causing a conflict.

§expected_revision_no: Option<RevisionNo>

When set (with replace behavior), the put applies only while the file’s current revision is still this one; a raced write fails the request instead of silently stacking on it, and a missing file answers path_not_found.

§

DeletePath

Delete one path.

Fields

§path: AbsolutePath

Absolute path that must resolve to a visible inode.

§behavior: DeleteDirectoryBehavior

Whether a non-empty directory may be tombstoned recursively.

§expected_inode_id: Option<InodeId>

When set, the delete applies only if the path still resolves to this inode; a raced rebinding fails the request instead of deleting (and reporting a recovery handle for) the wrong inode.

§

MovePath

Move one path to another path.

Fields

§from_path: AbsolutePath

Absolute source path that must resolve to a visible inode.

§to_path: AbsolutePath

Absolute destination whose parent must be visible and writable.

§behavior: DestinationBehavior

Whether an existing destination file may be replaced.

§

CopyPath

Copy one file path to another path.

Fields

§from_path: AbsolutePath

Absolute source path that must resolve to a visible file.

§to_path: AbsolutePath

Absolute destination whose parent must be visible and writable.

§behavior: DestinationBehavior

Whether an existing destination file may receive a copied revision.

§

Undelete

Restore a deleted file or subtree.

inode_id and deletion_seq identify one exact deletion. A stale sequence returns not_deleted and cannot undo a later deletion.

Fields

§inode_id: InodeId

Deleted inode to make reachable again.

§deletion_seq: ChangeSeq

Observed deletion sequence, which prevents cancelling a newer tombstone generation.

§path: Option<AbsolutePath>

Optional destination for the restored inode.

When absent, the inode is rebound to the parent and name recorded by the deletion. Parent identity, rather than an old path string, keeps this correct after ancestor renames. An explicit path is required when the deletion recorded no binding.

§

RestoreRevision

Restore an older revision as the current revision for a path.

Fields

§path: AbsolutePath

Absolute path that must resolve to a visible file.

§source_revision_no: RevisionNo

Existing historical revision whose content will be copied into a new current revision.

§

UpdateAttributes

Write and remove attributes on the inode one path resolves to.

Fields

§path: AbsolutePath

Absolute path that must resolve to a visible file or directory.

§set: BTreeMap<AttributeKey, AttributeValue>

Attributes to write. Each key replaces whatever the inode currently holds under it; keys the inode holds and this map does not name are left alone.

§remove: Vec<AttributeKey>

Attribute keys to remove.

A list preserves duplicate entries so validation can report them instead of silently deduplicating the request.

§expected_inode_id: Option<InodeId>

When set, the update applies only if the path still resolves to this inode; a raced rebinding fails the request instead of writing attributes onto the wrong inode.

§expected_attributes_revision_no: Option<AttributeRevisionNo>

When set, the update applies only while the inode’s attribute revision is still this one. Absent means the update is applied over whatever revision is current; either way the write carries its own revision guard, so a concurrent update never merges silently.

Trait Implementations§

Source§

impl Clone for FilesystemOperation

Source§

fn clone(&self) -> FilesystemOperation

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 FilesystemOperation

Source§

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

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

impl<'de> Deserialize<'de> for FilesystemOperation

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for FilesystemOperation

Source§

impl PartialEq for FilesystemOperation

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for FilesystemOperation

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for FilesystemOperation

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Same for T

Source§

type Output = T

Should always be Self
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.