Struct OutputMeta 

pub struct OutputMeta<'a> {
    pub name: &'a str,
    pub media_type: Option<&'a str>,
    pub framing: Framing,
    pub help: Option<&'a str>,
    pub default: bool,
    pub hide: bool,
    pub select: Option<&'a str>,
    pub schema: Option<&'a str>,
    pub schema_fn: Option<fn() -> String>,
}

One thing a command can write.

Fields

name: &'a str

The token a user types for it.

media_type: Option<&'a str>

The media type of the bytes, independent of their stream framing.

framing: Framing

help: Option<&'a str>

default: bool

What the command writes when nothing selects otherwise.

hide: bool

Remove an inherited output of the same name.

select: Option<&'a str>

A boolean flag whose presence picks this output, for the --json spelling.

schema: Option<&'a str>

A JSON Schema written into the table as text.

What a hand-written table or an include_str!ed file uses. A derive that lowers a Rust type uses Self::schema_fn instead, because schema_for! is a call.

schema_fn: Option<fn() -> String>

A JSON Schema produced on demand.

A fn pointer for the same reason Completer is one: this lives in a &'static table that a const expression initializes, and a schema derived from a Rust type is a runtime call. Preferred over Self::schema when both are set.

Implementations

impl OutputMeta<'_>

pub const EMPTY: OutputMeta<'static>

A named output with nothing else said about it, for struct-update syntax.

pub fn schema_text(&self) -> Option<String>

The schema, whichever way it was declared.

Trait Implementations

impl<'a> Clone for OutputMeta<'a>

fn clone(&self) -> OutputMeta<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for OutputMeta<'a>

impl<'a> Debug for OutputMeta<'a>

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

Formats the value using the given formatter.