Enum Help 

#[non_exhaustive]
pub enum Help {
    List {
        title: Option<String>,
        items: Vec<(String, String)>,
        cr: bool,
    },
    Words(Vec<String>),
    Unrecognized,
    Error(Error),
}

the answer to “?”

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

List

what may follow: (label, description) in display order; cr when the command may end here; the mode’s title for an empty line

Fields

title: Option<String>

items: Vec<(String, String)>

cr: bool

Words(Vec<String>)

the keywords a partly typed word may become

Unrecognized

nothing starts like the partly typed word

Error(Error)

Implementations

impl Help

pub fn render(&self, col: usize, line: &str) -> String

the console text (col: the prompt’s length, for an error marker)

Trait Implementations

impl Clone for Help

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Help

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

Formats the value using the given formatter.

impl Eq for Help

impl PartialEq for Help

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Help