Struct clap_builder::builder::StyledStr

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

Terminal-styling container

Styling may be encoded as ANSI Escape Code

Examples

// `cstr!` converts tags to ANSI codes
let after_help: &'static str = color_print::cstr!(
r#"<bold><underline>Examples</underline></bold>

  <dim>$</dim> <bold>mybin --input file.toml</bold>
"#);

let cmd = clap::Command::new("mybin")
    .after_help(after_help)  // The `&str` gets converted into a `StyledStr`
    // ...

Implementations

impl StyledStr

pub const fn new() -> Self

Create an empty buffer

pub fn ansi(&self) -> impl Display + '_

Display using ANSI Escape Code styling

Trait Implementations

impl Clone for StyledStr

fn clone(&self) -> StyledStr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StyledStr

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

Formats the value using the given formatter.

impl Default for &StyledStr

fn default() -> Self

Returns the “default value” for a type.

impl Default for StyledStr

fn default() -> StyledStr

Returns the “default value” for a type.

impl Display for StyledStr

Color-unaware printing. Never uses coloring.

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

Formats the value using the given formatter.

impl From<&&'static str> for StyledStr

fn from(name: &&'static str) -> Self

Converts to this type from the input type.

impl From<&String> for StyledStr

fn from(name: &String) -> Self

Converts to this type from the input type.

impl From<&'static str> for StyledStr

fn from(name: &'static str) -> Self

Converts to this type from the input type.

impl From<String> for StyledStr

fn from(name: String) -> Self

Converts to this type from the input type.

impl IntoResettable<StyledStr> for Option<&'static str>

fn into_resettable(self) -> Resettable<StyledStr>

Convert to the intended resettable type

impl Ord for StyledStr

fn cmp(&self, other: &StyledStr) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for StyledStr

fn eq(&self, other: &StyledStr) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for StyledStr

fn partial_cmp(&self, other: &StyledStr) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Write for StyledStr

fn write_str(&mut self, s: &str) -> Result<(), Error>

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl Eq for StyledStr

impl StructuralEq for StyledStr

impl StructuralPartialEq for StyledStr