Struct VolumeBackups 

pub struct VolumeBackups { /* private fields */ }

Every org’s volume snapshots and staged restores.

Implementations

impl VolumeBackups

pub fn restore( &self, org: &OrgId, req: VolumeRestoreRequest, by: &str, ) -> Result<(Run, Staged)>

Restore into a new staged volume, in the background. Returns the run and where the restore lands.

pub fn staged_list( &self, org: &OrgId, volume: Option<&str>, ) -> Result<Vec<StagedRestore>>

The org’s staged restores (of volume, or all).

pub fn staged_discard( &self, org: &OrgId, volume: &str, stamp: &str, ) -> Result<Value>

Detach and delete a staged restore. Refuses a volume that is not one.

impl VolumeBackups

pub fn new(state: &Path, apps: Apps, backups: Backups) -> VolumeBackups

pub fn set_scheduler(&self, s: Scheduler)

pub fn backups(&self) -> &Backups

pub fn runs(&self, org: &OrgId, volume: &str) -> RunStore

Snapshot runs of a volume.

pub fn configured(&self, org: &OrgId) -> Vec<String>

Volumes with stored settings.

pub fn record(&self, org: &OrgId, volume: &str) -> Result<Option<VolumeRecord>>

pub fn info(&self, org: &OrgId, volume: &str) -> Result<VolumeInfo>

The volume as incus has it (it must exist in the org).

pub fn update( &self, org: &OrgId, volume: &str, patch: &Value, ) -> Result<VolumeRecord>

Change a volume’s settings with a merge patch (schedule: null or "" removes the schedule).

pub fn next_run(&self, r: &VolumeRecord) -> Option<i64>

pub fn snapshots(&self, org: &OrgId, volume: &str) -> Result<Vec<Snapshot>>

Snapshots, newest first.

pub fn snapshot_delete( &self, org: &OrgId, volume: &str, snapshot: &str, ) -> Result<()>

pub fn create( &self, org: &OrgId, volume: &str, size: Option<&str>, ) -> Result<bool>

Create an empty volume in the org’s pool, size or (under a disk limit) the default. False when it already exists, as isb volume create says.

pub fn delete(&self, org: &OrgId, volume: &str) -> Result<()>

Delete a volume and its snapshots, and forget its settings and runs. Refused while an instance uses it (as incus refuses), while a snapshot of it is being taken, while a backup names it, and for a staged restore, which staged_discard detaches first.

pub fn snapshot( &self, org: &OrgId, volume: &str, name: SnapshotName, (trigger, by, slot): (RunTrigger, &str, Option<i64>), ) -> Result<Option<Run>>

Take a snapshot in the background (hook first). None when one of this volume is already being taken.

Trait Implementations

impl Clone for VolumeBackups

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Scheduled for VolumeBackups

fn entries(&self) -> Vec<Entry>

Every enabled schedule.

fn fire(&self, e: &Entry, slot: i64, late: bool)

Record slot as the entry’s anchor, then start its run (without blocking the scheduler). The anchor must be saved before this returns, so a slot never fires twice.

fn advance(&self, e: &Entry, to: i64)

Move the anchor without running (missed beyond the grace window).