Enum Effect 

pub enum Effect {
    PathCreate {
        path: PathBuf,
    },
    File {
        path: PathBuf,
        prev_blob: String,
        meta: Meta,
    },
    Symlink {
        path: PathBuf,
        target: PathBuf,
    },
    Dir {
        path: PathBuf,
        mode: u32,
        entries: Vec<String>,
    },
    HttpMutation {
        method: String,
        url: String,
        compensator: Option<HttpCompensator>,
    },
    Exec {
        command: String,
        cwd: PathBuf,
    },
}

A reversible (or at least auditable) side effect.

The Path* / File / Symlink / Dir variants are fully reversible. HttpMutation and Exec are recorded for audit and carry the shape needed to reverse them later, but are not auto-reversed yet.

Variants

PathCreate

A path that did not exist when we captured it. Inverse: delete whatever is now there (file, symlink, or whole directory tree).

Fields

path: PathBuf

File

A regular file whose prior contents + metadata were captured. Inverse: restore the contents and re-apply mode/mtime.

Fields

path: PathBuf

prev_blob: String

meta: Meta

Symlink

A symlink that existed at capture time. Inverse: recreate it pointing at target (we snapshot the link itself, never the file it points to).

Fields

path: PathBuf

target: PathBuf

Dir

A directory that existed at capture time, plus the names of its immediate children. Inverse: ensure the directory exists with its mode, and prune any children the agent added that weren’t here originally.

Fields

path: PathBuf

mode: u32

entries: Vec<String>

HttpMutation

A network mutation (POST/PUT/PATCH/DELETE). The compensator is the request that reverses it (e.g. a DELETE to undo a POST). Recorded only.

Fields

method: String

url: String

compensator: Option<HttpCompensator>

Exec

A shell command. Audit-only; arbitrary commands have no general inverse.

Fields

command: String

cwd: PathBuf

Implementations

impl Effect

pub fn reversible(&self) -> bool

Can this effect be reversed automatically?

pub fn path(&self) -> Option<&Path>

The filesystem path this effect concerns, if any.

pub fn describe(&self) -> String

A short, human-readable, log-friendly description.

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Effect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Effect

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Effect

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Effect

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

where __S: Serializer,

Serialize this value into the given Serde serializer.