Enum Framing 

pub enum Framing {
    Text,
    Json,
    Jsonl,
}

The wire format of what a command writes to stdout.

This is the machine contract, distinct from the name a user types for it. It is what decides a consumer’s shape: Framing::Json is read to EOF and parsed once, so a generated client returns a value; Framing::Jsonl arrives a line at a time and may never end, so a generated client has to return an iterator and must not buffer.

Variants

Text

Human-readable text. Nothing may be assumed about its structure, and it is the default because an output that says nothing about its framing is prose.

Json

One JSON document, read to end of stream.

Jsonl

One JSON document per line. Line-delimited, unbounded, and read incrementally — ndjson is the same thing under another name.

Implementations

impl Framing

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

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

Formats the value using the given formatter.

impl Default for Framing

fn default() -> Framing

Returns the “default value” for a type.

impl Display for Framing

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

Formats the value using the given formatter.

impl Eq for Framing

impl FromStr for Framing

type Err = EnumParseError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for Framing

fn cmp(&self, other: &Framing) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Framing

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Framing

fn partial_cmp(&self, other: &Framing) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Framing

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Framing