Skip to main content

## StyledStr

# Struct StyledStr

Source

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

Expand description

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§

Source§

### impl StyledStr

Source

#### pub const fn new() -> StyledStr

Create an empty buffer

Source

#### pub fn ansi(&self) -> impl Display

Available on crate feature `color` only.

Display using ANSI Escape Code styling

Source

#### pub fn push_str(&mut self, msg: &str)

Appends a given string slice onto the end of this `StyledStr`.

## Trait Implementations§

Source§

### impl Clone for StyledStr

Source§

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

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 StyledStr

Source§

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

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

### impl Default for StyledStr

Source§

#### fn default() -> StyledStr

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

### impl Default for &StyledStr

Source§

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

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

### impl Display for StyledStr

Color-unaware printing. Never uses coloring.

Source§

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

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

### impl Eq for StyledStr

Source§

### impl From<&&'static str> for StyledStr

Source§

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

Converts to this type from the input type.
Source§

### impl From<&'static str> for StyledStr

Source§

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

Converts to this type from the input type.
Source§

### impl From<&String> for StyledStr

Source§

#### fn from(name: &String) -> StyledStr

Converts to this type from the input type.
Source§

### impl From<Cow<'static, str>> for StyledStr

Source§

#### fn from(cow: Cow<'static, str>) -> StyledStr

Converts to this type from the input type.
Source§

### impl From<String> for StyledStr

Source§

#### fn from(name: String) -> StyledStr

Converts to this type from the input type.
Source§

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

Source§

#### fn into_resettable(self) -> Resettable<StyledStr>

Convert to the intended resettable type
Source§

### impl Ord for StyledStr

Source§

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

This method returns an `Ordering` between `self` and `other`. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

#### fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

### impl PartialEq for StyledStr

Source§

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

Equality operator `==`. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator `!=`. Read more
Source§

### impl PartialOrd for StyledStr

Source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more
Source§

### impl StructuralPartialEq for StyledStr

Source§

### impl Write for StyledStr

Source§

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

Writes a string slice into this writer, returning whether the write succeeded. Read more
Source§

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

Writes a `char` into this writer, returning whether the write succeeded. Read more
1.0.0 · Source§

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

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

## Auto Trait Implementations§

§

### impl Freeze for StyledStr

§

### impl RefUnwindSafe for StyledStr

§

### impl Send for StyledStr

§

### impl Sync for StyledStr

§

### impl Unpin for StyledStr

§

### impl UnsafeUnpin for StyledStr

§

### impl UnwindSafe for StyledStr

## 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<I> IntoResettable<StyledStr> for I
where I: Into<StyledStr>,

Source§

#### fn into_resettable(self) -> Resettable<StyledStr>

Convert to the intended resettable type
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> ToString for T
where T: Display + ?Sized,

Source§

#### fn to_string(&self) -> String

Converts the given value to a `String`. 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.