Struct Incoming 

pub struct Incoming {
    root: PathBuf,
}

The folders of requests and of their files.

Fields

root: PathBuf

Implementations

impl Incoming

pub fn here() -> Incoming

Those of this profile: handed/ in Sioul’s data folder.

pub fn at(root: &Path) -> Incoming

Those in root (tests).

fn requests(&self) -> PathBuf

pub fn files(&self) -> PathBuf

Where the files of every request are copied, each in a folder of its own.

fn named(&self, id: &str, suffix: &str) -> PathBuf

pub fn files_of(&self, id: &str) -> PathBuf

Where the files of request id are copied.

pub fn hand(&self, handed: &Handed) -> Result<PathBuf, String>

A request handed for the window to take: written whole or not at all.

pub fn waiting(&self) -> Vec<Handed>

The requests waiting, oldest first. One that does not read (cut, or from a newer Sioul) is set aside as .unread, read no more.

pub fn arrived(&self, id: &str) -> Option<Arrived>

The files copied for request id, once they all are; none before.

pub fn mark( &self, id: &str, draft: &str, copier: u32, files: u32, ) -> Result<(), String>

Request id taken, made into draft draft, files still coming from process copier: kept, so that a Sioul started again finds them.

pub fn marks(&self) -> Vec<Mark>

The requests taken whose files were still coming.

pub fn done(&self, id: &str)

Request id done with: its request, its mark, its arrival.

pub fn drop_request(&self, id: &str)

Request id dropped, the files copied for it too (no draft to take them).

pub fn salvage(&self, id: &str, expected: u32) -> Arrived

What arrived of request id when its copy stopped before the end (Sioul stopped meanwhile): the files copied whole; those cut short removed and said, as those never begun.

pub fn tidy(&self, held: &[PathBuf], now: SystemTime)

Folders of copies nobody holds any more (a draft gone in a way that left them, a Sioul stopped while copying), removed once a day old. held are the files the drafts hold.

Trait Implementations

impl Clone for Incoming

fn clone(&self) -> Incoming

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Incoming

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

Formats the value using the given formatter.