[go: up one dir, main page]

Struct clap::builder::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

Available on crate feature unstable-styles only.

No terminal styling

source

pub const fn styled() -> Styles

Available on crate feature unstable-styles only.

Default terminal styling

source

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

Available on crate feature unstable-styles only.

General Heading style, e.g. help_heading

source

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

Available on crate feature unstable-styles only.

Error heading

source

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

Available on crate feature unstable-styles only.

Usage heading

source

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

Available on crate feature unstable-styles only.

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

source

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

Available on crate feature unstable-styles only.

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

source

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

Available on crate feature unstable-styles only.

Highlight suggested usage

source

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

Available on crate feature unstable-styles only.

Highlight invalid usage

source§

impl Styles

Reflection

source

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

Available on crate feature unstable-styles only.

General Heading style, e.g. help_heading

source

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

Available on crate feature unstable-styles only.

Error heading

source

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

Available on crate feature unstable-styles only.

Usage heading

source

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

Available on crate feature unstable-styles only.

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

source

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

Available on crate feature unstable-styles only.

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

source

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

Available on crate feature unstable-styles only.

Highlight suggested usage

source

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

Available on crate feature unstable-styles only.

Highlight invalid usage

Trait Implementations§

source§

impl Clone for Styles

source§

fn clone(&self) -> Styles

Returns a copy of the value. Read more
1.0.0 · 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§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. 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 Twhere 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 Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.