Enum Style

#[non_exhaustive]
pub enum Style {
    Text,
    Emphasis,
    Literal,
    Metavar,
    Invalid,
}

Style of a text fragment inside of Doc

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.

Text

Plain text, no decorations

Emphasis

Word with emphasis - things like “Usage”, “Available options”, etc

Literal

Something user needs to type literally - command names, etc

Metavar

Metavavar placeholder - something user needs to replace with own input

Invalid

Invalid input given by user - used to display invalid parts of the input

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Style

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

Formats the value using the given formatter.

impl PartialEq for Style

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

impl Eq for Style

impl StructuralPartialEq for Style