Skip to main content

## Styles

# Struct Styles

Source

    pub struct Styles { /* private fields */ }

Expand description

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§

Source§

### impl Styles

Source

#### pub const fn plain() -> Styles

No terminal styling

Source

#### pub const fn styled() -> Styles

Default terminal styling

##### Examples found in repository?

examples/cargo-example-derive.rs (line 12)

    12pub const CLAP_STYLING: clap::builder::styling::Styles = clap::builder::styling::Styles::styled()
    13    .header(clap_cargo::style::HEADER)
    14    .usage(clap_cargo::style::USAGE)
    15    .literal(clap_cargo::style::LITERAL)
    16    .placeholder(clap_cargo::style::PLACEHOLDER)
    17    .error(clap_cargo::style::ERROR)
    18    .valid(clap_cargo::style::VALID)
    19    .invalid(clap_cargo::style::INVALID);

Source

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

General Heading style, e.g. `help_heading`

##### Examples found in repository?

examples/cargo-example-derive.rs (line 13)

    12pub const CLAP_STYLING: clap::builder::styling::Styles = clap::builder::styling::Styles::styled()
    13    .header(clap_cargo::style::HEADER)
    14    .usage(clap_cargo::style::USAGE)
    15    .literal(clap_cargo::style::LITERAL)
    16    .placeholder(clap_cargo::style::PLACEHOLDER)
    17    .error(clap_cargo::style::ERROR)
    18    .valid(clap_cargo::style::VALID)
    19    .invalid(clap_cargo::style::INVALID);

Source

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

Error heading

##### Examples found in repository?

examples/cargo-example-derive.rs (line 17)

    12pub const CLAP_STYLING: clap::builder::styling::Styles = clap::builder::styling::Styles::styled()
    13    .header(clap_cargo::style::HEADER)
    14    .usage(clap_cargo::style::USAGE)
    15    .literal(clap_cargo::style::LITERAL)
    16    .placeholder(clap_cargo::style::PLACEHOLDER)
    17    .error(clap_cargo::style::ERROR)
    18    .valid(clap_cargo::style::VALID)
    19    .invalid(clap_cargo::style::INVALID);

Source

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

Usage heading

##### Examples found in repository?

examples/cargo-example-derive.rs (line 14)

    12pub const CLAP_STYLING: clap::builder::styling::Styles = clap::builder::styling::Styles::styled()
    13    .header(clap_cargo::style::HEADER)
    14    .usage(clap_cargo::style::USAGE)
    15    .literal(clap_cargo::style::LITERAL)
    16    .placeholder(clap_cargo::style::PLACEHOLDER)
    17    .error(clap_cargo::style::ERROR)
    18    .valid(clap_cargo::style::VALID)
    19    .invalid(clap_cargo::style::INVALID);

Source

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

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

##### Examples found in repository?

examples/cargo-example-derive.rs (line 15)

    12pub const CLAP_STYLING: clap::builder::styling::Styles = clap::builder::styling::Styles::styled()
    13    .header(clap_cargo::style::HEADER)
    14    .usage(clap_cargo::style::USAGE)
    15    .literal(clap_cargo::style::LITERAL)
    16    .placeholder(clap_cargo::style::PLACEHOLDER)
    17    .error(clap_cargo::style::ERROR)
    18    .valid(clap_cargo::style::VALID)
    19    .invalid(clap_cargo::style::INVALID);

Source

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

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

##### Examples found in repository?

examples/cargo-example-derive.rs (line 16)

    12pub const CLAP_STYLING: clap::builder::styling::Styles = clap::builder::styling::Styles::styled()
    13    .header(clap_cargo::style::HEADER)
    14    .usage(clap_cargo::style::USAGE)
    15    .literal(clap_cargo::style::LITERAL)
    16    .placeholder(clap_cargo::style::PLACEHOLDER)
    17    .error(clap_cargo::style::ERROR)
    18    .valid(clap_cargo::style::VALID)
    19    .invalid(clap_cargo::style::INVALID);

Source

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

Highlight suggested usage

##### Examples found in repository?

examples/cargo-example-derive.rs (line 18)

    12pub const CLAP_STYLING: clap::builder::styling::Styles = clap::builder::styling::Styles::styled()
    13    .header(clap_cargo::style::HEADER)
    14    .usage(clap_cargo::style::USAGE)
    15    .literal(clap_cargo::style::LITERAL)
    16    .placeholder(clap_cargo::style::PLACEHOLDER)
    17    .error(clap_cargo::style::ERROR)
    18    .valid(clap_cargo::style::VALID)
    19    .invalid(clap_cargo::style::INVALID);

Source

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

Highlight invalid usage

##### Examples found in repository?

examples/cargo-example-derive.rs (line 19)

    12pub const CLAP_STYLING: clap::builder::styling::Styles = clap::builder::styling::Styles::styled()
    13    .header(clap_cargo::style::HEADER)
    14    .usage(clap_cargo::style::USAGE)
    15    .literal(clap_cargo::style::LITERAL)
    16    .placeholder(clap_cargo::style::PLACEHOLDER)
    17    .error(clap_cargo::style::ERROR)
    18    .valid(clap_cargo::style::VALID)
    19    .invalid(clap_cargo::style::INVALID);

Source

#### 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`

Source

#### 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.

Source§

### impl Styles

Reflection

Source

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

General Heading style, e.g. `help_heading`

Source

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

Error heading

Source

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

Usage heading

Source

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

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

Source

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

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

Source

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

Highlight suggested usage

Source

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

Highlight invalid usage

Source

#### 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`

Source

#### 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§

Source§

### impl Clone for Styles

Source§

#### fn clone(&self) -> Styles

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for Styles

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl Default for Styles

Source§

#### fn default() -> Styles

Returns the “default value” for a type. Read more
Source§

### impl Default for &Styles

Source§

#### fn default() -> &Styles

Returns the “default value” for a type. Read more

## Auto Trait Implementations§

§

### impl Freeze for Styles

§

### impl RefUnwindSafe for Styles

§

### impl Send for Styles

§

### impl Sync for Styles

§

### impl Unpin for Styles

§

### impl UnsafeUnpin for Styles

§

### impl UnwindSafe for Styles

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.