Enum FileTreeMutation

#[non_exhaustive]
pub enum FileTreeMutation {
    CreateDirectory {
        parent: FileTreeNodeId,
        uri: FileUri,
    },
    CreateEntry {
        parent: FileTreeNodeId,
        node_id: FileTreeNodeId,
        uri: FileUri,
        kind: FileKind,
    },
    Move {
        node_id: FileTreeNodeId,
        from: FileUri,
        to: FileUri,
    },
    Remove {
        node_id: FileTreeNodeId,
        uri: FileUri,
        recursive: bool,
    },
}

Provider mutation executed serially on the filesystem worker.

URIs are provider-neutral identifiers. recursive is forwarded without reinterpretation, and CreateEntry accepts any [FileKind] at the type level although the worker supports only file and directory creation.

Examples

use ailloli_ui_fs::{FileKind, FileMetadata, FileTreeStore, FileUri};
use ailloli_ui_fs_runtime::FileTreeMutation;
let store = FileTreeStore::new(FileUri::parse("file:///")?, FileMetadata::new(FileKind::Directory))?;
let mutation = FileTreeMutation::Remove {
    node_id: store.root(),
    uri: FileUri::parse("file:///")?,
    recursive: true,
};
assert_eq!(mutation.target_node_id(), store.root());

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CreateDirectory

Creates a directory and later inserts the attested result under parent.

Fields

parent: FileTreeNodeId

Existing store node that receives the new child.

uri: FileUri

Exact provider URI to create.

CreateEntry

Creates a file or directory with an identity reserved by the UI store.

Fields

parent: FileTreeNodeId

Existing store node that receives the new child.

node_id: FileTreeNodeId

Store-local ID reserved before enqueueing the operation.

uri: FileUri

Exact provider URI to create.

kind: FileKind

Entry kind; only [FileKind::File] and [FileKind::Directory] work.

Move

Moves an existing entry and preserves its store-local node ID.

Fields

node_id: FileTreeNodeId

Existing store-local ID to update after provider attestation.

from: FileUri

Exact current provider URI.

to: FileUri

Exact destination provider URI.

Remove

Removes an existing entry after provider confirmation.

Fields

node_id: FileTreeNodeId

Existing store-local ID to remove.

uri: FileUri

Exact provider URI to remove.

recursive: bool

Whether provider-defined recursive removal is permitted.

Implementations

impl FileTreeMutation

Accessors for store ownership and optional reserved identity.

pub const fn target_node_id(&self) -> FileTreeNodeId

Returns the node serialized against other active mutations.

Create operations target their parent; move/remove operations target the affected node.

Examples

use ailloli_ui_fs::{FileKind, FileMetadata, FileTreeStore, FileUri};
use ailloli_ui_fs_runtime::FileTreeMutation;
let store = FileTreeStore::new(FileUri::parse("file:///")?, FileMetadata::new(FileKind::Directory))?;
let mutation = FileTreeMutation::CreateDirectory { parent: store.root(), uri: FileUri::parse("file:///new")? };
assert_eq!(mutation.target_node_id(), store.root());

pub const fn reserved_node_id(&self) -> Option<FileTreeNodeId>

Returns the preallocated ID only for FileTreeMutation::CreateEntry.

Examples

use ailloli_ui_fs::{FileKind, FileMetadata, FileTreeStore, FileUri};
use ailloli_ui_fs_runtime::FileTreeMutation;
let mut store = FileTreeStore::new(FileUri::parse("file:///")?, FileMetadata::new(FileKind::Directory))?;
let reserved = store.reserve_node_id()?;
let mutation = FileTreeMutation::CreateEntry { parent: store.root(), node_id: reserved, uri: FileUri::parse("file:///new.txt")?, kind: FileKind::File };
assert_eq!(mutation.reserved_node_id(), Some(reserved));

Trait Implementations

impl Clone for FileTreeMutation

fn clone(&self) -> FileTreeMutation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileTreeMutation

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

Formats the value using the given formatter.

impl PartialEq for FileTreeMutation

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

impl StructuralPartialEq for FileTreeMutation