Enum PlannedChange 

#[non_exhaustive]
pub enum PlannedChange {
    CreateFile {
        path: PathBuf,
    },
    PatchFile {
        path: PathBuf,
    },
    RemoveFile {
        path: PathBuf,
    },
    RestoreBackup {
        backup: PathBuf,
        target: PathBuf,
    },
    CreateBackup {
        backup: PathBuf,
        target: PathBuf,
    },
    CreateDir {
        path: PathBuf,
    },
    RemoveDir {
        path: PathBuf,
    },
    WriteLedger {
        path: PathBuf,
        key: String,
        owner: String,
    },
    RemoveLedgerEntry {
        path: PathBuf,
        key: String,
    },
    SetPermissions {
        path: PathBuf,
        mode: u32,
    },
    NoOp {
        path: PathBuf,
        reason: String,
    },
    Refuse {
        path: Option<PathBuf>,
        reason: RefusalReason,
    },
}

One concrete change in a dry-run plan.

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.

CreateFile

Create a file.

Fields

path: PathBuf

File path.

PatchFile

Patch an existing file in place.

Fields

path: PathBuf

File path.

RemoveFile

Remove a file.

Fields

path: PathBuf

File path.

RestoreBackup

Restore a backup file over its original target.

Fields

backup: PathBuf

Backup path.

target: PathBuf

Restore target path.

CreateBackup

Create a backup file before patching a target.

Fields

backup: PathBuf

Backup path.

target: PathBuf

Original target path.

CreateDir

Create a directory.

Fields

path: PathBuf

Directory path.

RemoveDir

Remove a directory.

Fields

path: PathBuf

Directory path.

WriteLedger

Write or update an ownership ledger entry.

Fields

path: PathBuf

Ledger file path.

key: String

Ledger key.

owner: String

Owner tag.

RemoveLedgerEntry

Remove an ownership ledger entry.

Fields

path: PathBuf

Ledger file path.

key: String

Ledger key.

SetPermissions

Set file permissions.

Fields

path: PathBuf

File path.

mode: u32

Unix mode, no-op on non-Unix platforms.

NoOp

No filesystem or ledger change is needed for this path.

Fields

path: PathBuf

Path checked by the planner.

reason: String

Human-readable no-op reason.

Refuse

Refuse the operation before mutation.

Fields

path: Option<PathBuf>

Path that caused the refusal, when one exists.

reason: RefusalReason

Refusal reason.

Trait Implementations

impl Clone for PlannedChange

fn clone(&self) -> PlannedChange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlannedChange

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

Formats the value using the given formatter.

impl Eq for PlannedChange

impl PartialEq for PlannedChange

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