Struct clap::builder::styling::Styles

pub struct Styles { /* private fields */ }

Terminal styling definitions

See also [Command::styles][crate::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

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

Trait Implementations

impl Clone for Styles

fn clone(&self) -> Styles

Returns a copy 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.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 98 bytes