Struct ExampleView 

pub struct ExampleView {
    pub id: String,
    pub title: String,
    pub description: String,
    pub argv: Vec<String>,
    pub command: String,
    pub setup: Vec<SetupView>,
    pub expectation: String,
}

One example, as every projection shows it. The command lines are rendered from the declaration’s argv, never written out a second time, so what a reader copies is what the example test executed.

Fields

id: String

The example’s id, unique across the whole command line.

title: String

One line: what this example shows.

description: String

What it does and what comes back.

argv: Vec<String>

The argument vector, without the executable’s own name.

command: String

The command line as a person types it, rendered from argv.

setup: Vec<SetupView>

The commands that run before it in the same session; empty for an example that needs nothing prepared.

expectation: String

What the example test asserts, in one phrase; the evidence the page may cite.

Trait Implementations

impl Clone for ExampleView

fn clone(&self) -> ExampleView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExampleView

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

Formats the value using the given formatter.

impl Eq for ExampleView

impl PartialEq for ExampleView

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ExampleView

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 ExampleView