Struct LocalOutput 

pub struct LocalOutput {
    pub path: PathBuf,
    pub pre_existing: bool,
    pub replaced: bool,
}

One concrete local file a sink opened during a run.

Fields

path: PathBuf

The file the sink wrote, as the sink addressed it.

pre_existing: bool

The file already existed the first time this sink opened it — faucet appended to (or truncated) a file it did not create. A retention GC must never delete such a file; see the module docs.

replaced: bool

The sink truncated the file when it first opened it, so every byte in it is faucet’s own output even when pre_existing is set. It makes a pre-existing file safe to read back (a preview can only show what faucet wrote); it never makes it collectable.

Implementations

impl LocalOutput

pub fn created(path: impl Into<PathBuf>) -> Self

A file faucet created.

pub fn pre_existing(path: impl Into<PathBuf>) -> Self

A file that already existed when faucet first opened it.

pub fn replaced(path: impl Into<PathBuf>) -> Self

A file that already existed and that faucet truncated on its first open.

Trait Implementations

impl Clone for LocalOutput

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LocalOutput

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

Formats the value using the given formatter.

impl Eq for LocalOutput

impl PartialEq for LocalOutput

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LocalOutput