# Struct clap::builder::StyledStr

source · [−]

    pub struct StyledStr { /* private fields */ }

Expand description

Terminal-styling container

For now, this is the same as a `Str`. This exists to reserve space in the API for exposing terminal styling.

## Implementations

source

### impl StyledStr

source

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

Create an empty buffer

source

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

Display using ANSI Escape Code styling

## Trait Implementations

source

### impl Clone for StyledStr

source

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

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 StyledStr

source

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

Formats the value using the given formatter. Read more

source

### impl Default for &StyledStr

source

#### fn default() -> Self

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

Formats the value using the given formatter. Read more

source

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

source

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

Converts to this type from the input type.

source

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

source

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

Converts to this type from the input type.

source

### impl From<&String> for StyledStr

source

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

Converts to this type from the input type.

source

### impl From<String> for StyledStr

source

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

Converts to this type from the input type.

source

### impl<I: Into<StyledStr>> IntoResettable<StyledStr> for I

source

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

Convert to the intended resettable 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: &Self) -> Ordering

This method returns an `Ordering` between `self` and `other`. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

### impl PartialEq<StyledStr> for StyledStr

source

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

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

source

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

This method tests for `!=`.

source

### impl PartialOrd<StyledStr> for StyledStr

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

### impl Eq for StyledStr

source

### impl StructuralEq for StyledStr

source

### impl StructuralPartialEq for StyledStr

## Auto Trait Implementations

### impl RefUnwindSafe for StyledStr

### impl Send for StyledStr

### impl Sync for StyledStr

### impl Unpin 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,

const: unstable · source

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

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Returns the argument unchanged.

source

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

const: unstable · 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,

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

#### default 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>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · 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>,

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.