Struct Styles 

pub struct Styles(/* private fields */);

Terminal styling definitions for help text output.

This is a newtype wrapper around clap::builder::Styles to avoid exposing clap types directly in the public API. Use this with the #[conf(styles = ...)] attribute to customize the colors and formatting of help text.

Example

use conf::Conf;
use anstyle::{AnsiColor, Style};

const HELP_STYLES: conf::Styles = conf::Styles::styled()
    .header(AnsiColor::Blue.on_default().bold())
    .usage(AnsiColor::Blue.on_default().bold())
    .literal(AnsiColor::White.on_default())
    .placeholder(AnsiColor::Green.on_default());

#[derive(Conf)]
#[conf(styles = HELP_STYLES)]
struct Args {
    #[conf(long)]
    name: String,
}

Implementations

impl Styles

pub const fn plain() -> Self

Create styles with no terminal coloring.

pub const fn styled() -> Self

Create default terminal styling with colors enabled.

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

Style for general headings.

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

Style for error messages.

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

Style for usage headings.

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

Style for command syntax (e.g., --help).

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

Style for value names within syntax (e.g., <FILE>).

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

Style for suggested correct usage.

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

Style for incorrect usage.

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

Formats the value using the given formatter.