Enum Framing 

pub enum Framing {
    Text,
    Json,
    Jsonl,
}

The wire format of what a command writes to stdout.

The machine contract, as distinct from the token a user types for it: aube spells its line-delimited output ndjson and hk spells the identical format jsonl, so a consumer keys off this and a user off OutputMeta::name.

Variants

Text

Human-readable text, with no structure a consumer may assume.

Json

One JSON document, read to end of stream.

Jsonl

One JSON document per line, read incrementally and possibly unbounded.

Implementations

impl Framing

pub fn as_str(self) -> &'static str

The spelling used in a spec.

pub fn is_streaming(self) -> bool

Whether a consumer has to read this incrementally rather than to the end.

Trait Implementations

impl Clone for Framing

fn clone(&self) -> Framing

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Framing

impl Debug for Framing

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

Formats the value using the given formatter.

impl Default for Framing

fn default() -> Framing

Returns the “default value” for a type.

impl Eq for Framing

impl PartialEq for Framing

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Framing