Enum Output 

#[non_exhaustive]
pub enum Output<T: Serialize> {
    Render(T),
    Silent,
    Binary {
        data: Vec<u8>,
        filename: String,
    },
    Artifact(Artifact<T>),
}

What a handler produces.

This enum represents the different types of output a command handler can produce.

Binary vs. Artifact

Output::Binary hands bytes and a filename hint back to the caller: the framework writes them to stdout, or to an explicit --output-file-path override, and the filename never authorizes a filesystem write on its own.

Output::Artifact is the opt-in compound shape: bytes plus an optional suggested destination that does authorize a write, plus an application-owned semantic report the framework renders only after the write succeeds. See the artifact module for the destination policy and report channel.

Marked #[non_exhaustive] so future output shapes can be added without breaking exhaustive matchers.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Render(T)

Data to render with a template or serialize to JSON/YAML/etc.

Silent

Silent exit (no output produced)

Binary

Binary output for file exports

Fields

data: Vec<u8>

The binary data

filename: String

Suggested filename for the output

Artifact(Artifact<T>)

Owned artifact bytes with an optional suggested destination and an application-owned report rendered after the framework-owned write.

Implementations

impl<T: Serialize> Output<T>

pub fn is_render(&self) -> bool

Returns true if this is a render result.

pub fn is_silent(&self) -> bool

Returns true if this is a silent result.

pub fn is_binary(&self) -> bool

Returns true if this is a binary result.

pub fn is_artifact(&self) -> bool

Returns true if this is a compound artifact result.

Trait Implementations

impl<T: Debug + Serialize> Debug for Output<T>

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

Formats the value using the given formatter.