Struct Example 

pub struct Example {
    pub description: String,
    pub command: String,
    pub output: Option<String>,
}

A usage example for a command.

Examples are rendered in help output and Markdown documentation pages. Each example has a short human-readable description, the command string as it would be typed, and an optional expected output snippet.

Examples

let ex = Example::new("list all items", "myapp list")
    .with_output("item1\nitem2");

assert_eq!(ex.description, "list all items");
assert_eq!(ex.command, "myapp list");
assert_eq!(ex.output.as_deref(), Some("item1\nitem2"));

Fields

description: String

Short description of what the example demonstrates.

command: String

The full command string as it would be typed by the user.

output: Option<String>

Optional expected output shown below the command in help and documentation.

Implementations

impl Example

pub fn new(description: impl Into<String>, command: impl Into<String>) -> Self

Create a new Example with a description and command string.

The output field is None by default; use Example::with_output to attach expected output.

Arguments

• description — Short explanation of what the example shows.
• command — The command string as typed (including the program name).

Examples

let ex = Example::new("deploy to staging", "myapp deploy staging");
assert_eq!(ex.command, "myapp deploy staging");
assert!(ex.output.is_none());

pub fn with_output(self, output: impl Into<String>) -> Self

Attach an expected output snippet to this example.

The output is rendered as a comment in plain-text help and as a code block annotation in Markdown documentation.

Examples

let ex = Example::new("check version", "myapp --version")
    .with_output("myapp 1.0.0");

assert_eq!(ex.output.as_deref(), Some("myapp 1.0.0"));

Trait Implementations

impl Clone for Example

fn clone(&self) -> Example

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Example

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Example

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Example

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Example

fn cmp(&self, other: &Example) -> 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 Example

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

fn partial_cmp(&self, other: &Example) -> 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 Example

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Example

impl StructuralPartialEq for Example