Struct ExampleDoc 

pub struct ExampleDoc {
    pub id: &'static str,
    pub title: &'static str,
    pub description: &'static str,
    pub argv: &'static [&'static str],
    pub setup: &'static [&'static [&'static str]],
    pub expect: Expect,
}

One documented example of one command: what it shows, the argument vector it runs, what must happen when it runs, and anything that has to be done first. The argument vector is the canonical form; the command line a reader copies is rendered from it, never written out a second time.

Fields

id: &'static str

Unique across the whole command line; the anchor of the example on its page.

title: &'static str

One line: what this example shows.

description: &'static str

What it does and what comes back.

argv: &'static [&'static str]

The arguments, without the executable’s own name.

setup: &'static [&'static [&'static str]]

Commands run in the same repository before it, in order; usually empty.

expect: Expect

What the run must show.

Trait Implementations

impl Clone for ExampleDoc

fn clone(&self) -> ExampleDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ExampleDoc

impl Debug for ExampleDoc

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

Formats the value using the given formatter.

impl Eq for ExampleDoc

impl PartialEq for ExampleDoc

fn eq(&self, other: &ExampleDoc) -> 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 StructuralPartialEq for ExampleDoc