Struct CommandOutput 

pub struct CommandOutput { /* private fields */ }

Destination and presentation contract for a backup command result.

A successful command emits at most once. File output is replaced only when the result is ready, so validation and command failures preserve any pre-existing destination.

Implementations

impl CommandOutput

pub fn new(mode: OutputMode, path: Option<PathBuf>) -> Self

Creates an output contract for mode, writing to path when supplied and to stdout otherwise.

pub fn json() -> Self

Creates a compact-JSON contract writing to stdout.

pub fn human() -> Self

Creates a human-text contract writing to stdout.

pub const fn mode(&self) -> OutputMode

The requested presentation mode.

pub fn path(&self) -> Option<&Path>

The result destination file, or None for stdout.

pub const fn is_quiet(&self) -> bool

True when no normal output may be produced.

pub const fn is_json(&self) -> bool

True when the result is rendered as JSON.

pub const fn allows_progress(&self) -> bool

True when interactive progress reporting is appropriate: only for human output going to a terminal that is not competing with a machine-readable result document.

pub fn ensure_distinct_from( &self, other: &Path, description: &str, ) -> Result<()>

Rejects a result destination that aliases a command input or artifact.

Existing files are compared by filesystem identity, including hard links. Non-existing paths are compared after resolving their nearest existing ancestor, so relative paths and symlinked parent directories cannot bypass the check.

pub fn emit_json<T: Serialize + ?Sized>(&self, value: &T) -> Result<()>

Renders value as JSON, honoring compact/indented/quiet modes.

Use Self::emit when the command also has a human rendering.

pub fn emit_text(&self, text: &str) -> Result<()>

Writes already-rendered text, honoring quiet mode and file routing.

pub fn emit<T, F>(&self, value: &T, render_human: F) -> Result<()>

where T: Serialize + ?Sized, F: FnOnce() -> String,

Emits the result document: value in JSON modes, otherwise the text produced by render_human.

render_human is only evaluated when a human rendering is needed, so expensive formatting is skipped for JSON and quiet output.

Trait Implementations

impl Clone for CommandOutput

fn clone(&self) -> CommandOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandOutput

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

Formats the value using the given formatter.

impl Default for CommandOutput

fn default() -> CommandOutput

Returns the “default value” for a type.