Struct BackupRunPlan 

pub struct BackupRunPlan {

    pub service_name: String,
    pub service_home: PathBuf,
    pub repo: String,
    pub password: String,
    pub env: BTreeMap<String, String>,
    pub tags: Vec<String>,
    pub paths: Vec<PathBuf>,
    pub excludes: Vec<String>,
    pub online: bool,
    pub units: Vec<String>,
    pub data_paths: Vec<PathBuf>,
    pub pre_backup_hook: Option<PathBuf>,
    pub post_backup_hook: Option<PathBuf>,
}

Concrete instructions for backing up one installed service.

The CLI consumes this by:

1. Running every pre_backup_hook script in order.
2. Spawning restic backup with repo, password (via RESTIC_PASSWORD env), env set on the child, --tag for each string in tags, and --exclude for each string in excludes, with paths as the positional arguments.
3. Running every post_backup_hook (even if step 2 failed — failure-cleanup matters; see [PlanHook::Cleanup]).

Fields

service_name: String

service_home: PathBuf

repo: String

password: String

env: BTreeMap<String, String>

tags: Vec<String>

paths: Vec<PathBuf>

excludes: Vec<String>

online: bool

False (the default) means a cold snapshot: ryra stops units, makes data_paths readable, snapshots, then restarts. True means ryra leaves the service running and only drives the hooks (see [BackupConfig]).

units: Vec<String>

The service’s systemd units (one per container quadlet), derived so ryra can stop the whole stack for a cold snapshot. Empty for an online service.

data_paths: Vec<PathBuf>

The service’s data directories (absolute), derived from [backup].paths. Cold snapshots podman unshare chown these so restic can read them.

pre_backup_hook: Option<PathBuf>

post_backup_hook: Option<PathBuf>

Trait Implementations

impl Clone for BackupRunPlan

fn clone(&self) -> BackupRunPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BackupRunPlan

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

Formats the value using the given formatter.