Struct Store 

pub struct Store { /* private fields */ }

The server’s files. Clones share the same folder.

Implementations

impl Store

pub fn open(root: &Path) -> Result<Self>

Opens the store, creating its folders.

pub fn layouts(&self) -> Result<Vec<String>>

The names of the stored layouts.

pub fn layout_versions(&self, name: &str) -> Result<Vec<LayoutVersion>>

A layout’s versions, oldest first.

pub fn save_layout(&self, name: &str, json: &str) -> Result<u32>

Saves a layout. Saving what the latest version already holds adds no version. Returns the version that holds it.

pub fn layout( &self, name: &str, version: Option<u32>, ) -> Result<Option<(u32, String)>>

A layout’s text with its version: the latest, or the one asked for.

pub fn delete_layout(&self, name: &str) -> Result<bool>

Deletes a layout and all its versions. Returns whether it existed.

pub fn job_ids(&self) -> Result<Vec<String>>

The ids of the stored jobs.

pub fn save_job(&self, id: &str, job: &Job) -> Result<()>

Saves a job. Its next run is computed again.

pub fn job(&self, id: &str) -> Result<Option<Job>>

A job by id.

pub fn delete_job(&self, id: &str) -> Result<bool>

Deletes a job, with its history and kept documents. Returns whether it existed.

pub fn job_state(&self, id: &str) -> Result<JobState>

A job’s schedule state.

pub fn save_job_state(&self, id: &str, state: &JobState) -> Result<()>

Saves a job’s schedule state.

pub fn new_run_id(&self, now: Timestamp) -> String

A new run id, later than the ones before it.

pub fn save_run(&self, run: &RunRecord, limit: usize) -> Result<()>

Adds a run to a job’s history, dropping the oldest past limit.

pub fn runs(&self, job: &str, limit: usize) -> Result<Vec<RunRecord>>

A job’s runs, newest first, at most limit.

pub fn run(&self, job: &str, id: &str) -> Result<Option<RunRecord>>

One run of a job.

pub fn save_document( &self, job: &str, run: &str, file: &str, bytes: &[u8], ) -> Result<()>

Keeps a run’s file on the server.

pub fn document( &self, job: &str, run: &str, file: &str, ) -> Result<Option<Vec<u8>>>

A kept file.

pub fn purge_documents(&self, job: &str, cutoff: Timestamp) -> Result<usize>

Deletes a job’s kept files older than cutoff. Returns how many runs lost theirs.

Trait Implementations

impl Clone for Store

fn clone(&self) -> Store

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Store

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

Formats the value using the given formatter.