Struct Styles

pub struct Styles { /* private fields */ }

Terminal styling definitions

See also Command::styles.

Example

clap v3 styling

let styles = Styles::styled()
    .header(AnsiColor::Yellow.on_default())
    .usage(AnsiColor::Green.on_default())
    .literal(AnsiColor::Green.on_default())
    .placeholder(AnsiColor::Green.on_default());

Implementations

impl Styles

pub const fn plain() -> Styles

No terminal styling

pub const fn styled() -> Styles

Default terminal styling

pub const fn header(self, style: Style) -> Styles

General Heading style, e.g. help_heading

pub const fn error(self, style: Style) -> Styles

Error heading

pub const fn usage(self, style: Style) -> Styles

Usage heading

pub const fn literal(self, style: Style) -> Styles

Literal command-line syntax, e.g. --help

pub const fn placeholder(self, style: Style) -> Styles

Descriptions within command-line syntax, e.g. value_name

pub const fn valid(self, style: Style) -> Styles

Highlight suggested usage

pub const fn invalid(self, style: Style) -> Styles

Highlight invalid usage

pub const fn context(self, style: Style) -> Styles

Highlight all specified contexts, e.g. [default: false]

To specialize the style of the value within the context, see Styles::context_value

pub const fn context_value(self, style: Style) -> Styles

Highlight values within all of the context, e.g. the false in [default: false]

If not explicitly set, falls back to context’s style.

impl Styles

Reflection

pub const fn get_header(&self) -> &Style

General Heading style, e.g. help_heading

pub const fn get_error(&self) -> &Style

Error heading

pub const fn get_usage(&self) -> &Style

Usage heading

pub const fn get_literal(&self) -> &Style

Literal command-line syntax, e.g. --help

pub const fn get_placeholder(&self) -> &Style

Descriptions within command-line syntax, e.g. value_name

pub const fn get_valid(&self) -> &Style

Highlight suggested usage

pub const fn get_invalid(&self) -> &Style

Highlight invalid usage

pub const fn get_context(&self) -> &Style

Highlight all specified contexts, e.g. [default: false]

To specialize the style of the value within the context, see Styles::context_value

pub const fn get_context_value(&self) -> &Style

Highlight values within all of the context, e.g. the false in [default: false]

If not explicitly set, falls back to context’s style.

Trait Implementations

impl Clone for Styles

fn clone(&self) -> Styles

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Styles

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

Formats the value using the given formatter.

impl Default for &Styles

fn default() -> &Styles

Returns the “default value” for a type.

impl Default for Styles

fn default() -> Styles

Returns the “default value” for a type.