Enum DesiredMutation 

pub enum DesiredMutation {
    Create {
        scope: CloudScope,
        parent_id: CloudItemId,
        name: String,
        kind: CloudItemKind,
    },
    ModifyContent {
        key: CloudItemKey,
    },
    ModifyMetadata {
        key: CloudItemKey,
        parent_id: Option<CloudItemId>,
        name: Option<String>,
    },
    Delete {
        key: CloudItemKey,
    },
}

Product-neutral desired effect of a durable mutation.

Variants

Create

Creates a child below an existing directory.

Fields

scope: CloudScope

Namespace/root scope in which the child will be created.

parent_id: CloudItemId

Stable identity of the desired parent.

name: String

Desired child name, preserved without product normalization.

kind: CloudItemKind

Desired item kind.

ModifyContent

Replaces local content for an existing file.

Fields

key: CloudItemKey

Stable identity of the file being modified.

ModifyMetadata

Changes the parent, name, or both for an existing item.

Fields

key: CloudItemKey

Stable identity preserved by the metadata mutation.

parent_id: Option<CloudItemId>

Desired parent when this mutation moves the item.

name: Option<String>

Desired name when this mutation renames the item.

Delete

Deletes an existing item.

Fields

key: CloudItemKey

Stable identity of the item being deleted.

Implementations

impl DesiredMutation

pub fn create( scope: CloudScope, parent_id: CloudItemId, name: impl Into<String>, kind: CloudItemKind, ) -> Result<Self>

Creates a child intent with a non-empty opaque name.

Errors

Returns an error when validation fails or an underlying backend, store, or platform operation fails.

pub const fn modify_content(key: CloudItemKey) -> Self

Creates a content replacement intent.

pub fn modify_metadata( key: CloudItemKey, parent_id: Option<CloudItemId>, name: Option<String>, ) -> Result<Self>

Creates a metadata intent that changes the parent, name, or both.

Errors

Returns an error when validation fails or an underlying backend, store, or platform operation fails.

pub const fn delete(key: CloudItemKey) -> Self

Creates a delete intent.

pub const fn scope(&self) -> &CloudScope

Returns the namespace/root scope affected by this mutation.

pub const fn existing_item_key(&self) -> Option<&CloudItemKey>

Returns the existing item key when the mutation targets an already identified item.

Trait Implementations

impl Clone for DesiredMutation

fn clone(&self) -> DesiredMutation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DesiredMutation

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

Formats the value using the given formatter.

impl PartialEq for DesiredMutation

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

impl StructuralPartialEq for DesiredMutation