ansi_control_codes::explain

Trait Explain

Source 
pub trait Explain {
    // Required methods
    fn short_name(&self) -> Option<&'static str>;
    fn long_name(&self) -> &'static str;
    fn short_description(&self) -> String;
    fn long_description(&self) -> String;
}
Expand description

Explanation of an ansi-control-code.

Required Methods§

Source

fn short_name(&self) -> Option<&'static str>

Returns the short name (abbreviation) of this control function, e.g. CR, LF.

An abbreviated name is available for all ansi-escape-codes, except for those in the private use area.

Source

fn long_name(&self) -> &'static str

Returns the name of this control function, e.g. Carriage Return, Line Feed.

Source

fn short_description(&self) -> String

Returns the short description of what this function does.

Source

fn long_description(&self) -> String

Returns a long description of what this function does.

Not all control functions have a long description, in which case this will return the same as short_description().

Implementors§