# Struct termcolor::ColorSpec

source · [−]

    pub struct ColorSpec { /* private fields */ }

Expand description

A color specification.

## Implementations

source

### impl ColorSpec

source

#### pub fn new() -> ColorSpec

Create a new color specification that has no colors or styles.

source

#### pub fn fg(&self) -> Option<&Color>

Get the foreground color.

source

#### pub fn set_fg(&mut self, color: Option<Color>) -> &mut ColorSpec

Set the foreground color.

source

#### pub fn bg(&self) -> Option<&Color>

Get the background color.

source

#### pub fn set_bg(&mut self, color: Option<Color>) -> &mut ColorSpec

Set the background color.

source

#### pub fn bold(&self) -> bool

Get whether this is bold or not.

Note that the bold setting has no effect in a Windows console.

source

#### pub fn set_bold(&mut self, yes: bool) -> &mut ColorSpec

Set whether the text is bolded or not.

Note that the bold setting has no effect in a Windows console.

source

#### pub fn dimmed(&self) -> bool

Get whether this is dimmed or not.

Note that the dimmed setting has no effect in a Windows console.

source

#### pub fn set_dimmed(&mut self, yes: bool) -> &mut ColorSpec

Set whether the text is dimmed or not.

Note that the dimmed setting has no effect in a Windows console.

source

#### pub fn italic(&self) -> bool

Get whether this is italic or not.

Note that the italic setting has no effect in a Windows console.

source

#### pub fn set_italic(&mut self, yes: bool) -> &mut ColorSpec

Set whether the text is italicized or not.

Note that the italic setting has no effect in a Windows console.

source

#### pub fn underline(&self) -> bool

Get whether this is underline or not.

Note that the underline setting has no effect in a Windows console.

source

#### pub fn set_underline(&mut self, yes: bool) -> &mut ColorSpec

Set whether the text is underlined or not.

Note that the underline setting has no effect in a Windows console.

source

#### pub fn reset(&self) -> bool

Get whether reset is enabled or not.

reset is enabled by default. When disabled and using ANSI escape sequences, a “reset” code will be emitted every time a `ColorSpec`’s settings are applied.

Note that the reset setting has no effect in a Windows console.

source

#### pub fn set_reset(&mut self, yes: bool) -> &mut ColorSpec

Set whether to reset the terminal whenever color settings are applied.

reset is enabled by default. When disabled and using ANSI escape sequences, a “reset” code will be emitted every time a `ColorSpec`’s settings are applied.

Typically this is useful if callers have a requirement to more scrupulously manage the exact sequence of escape codes that are emitted when using ANSI for colors.

Note that the reset setting has no effect in a Windows console.

source

#### pub fn intense(&self) -> bool

Get whether this is intense or not.

On Unix-like systems, this will output the ANSI escape sequence that will print a high-intensity version of the color specified.

On Windows systems, this will output the ANSI escape sequence that will print a brighter version of the color specified.

source

#### pub fn set_intense(&mut self, yes: bool) -> &mut ColorSpec

Set whether the text is intense or not.

On Unix-like systems, this will output the ANSI escape sequence that will print a high-intensity version of the color specified.

On Windows systems, this will output the ANSI escape sequence that will print a brighter version of the color specified.

source

#### pub fn is_none(&self) -> bool

Returns true if this color specification has no colors or styles.

source

#### pub fn clear(&mut self)

Clears this color specification so that it has no color/style settings.

## Trait Implementations

source

### impl Clone for ColorSpec

source

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

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 ColorSpec

source

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

Formats the value using the given formatter. Read more

source

### impl Default for ColorSpec

source

#### fn default() -> ColorSpec

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

source

### impl PartialEq<ColorSpec> for ColorSpec

source

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

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

source

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

This method tests for `!=`.

source

### impl Eq for ColorSpec

source

### impl StructuralEq for ColorSpec

source

### impl StructuralPartialEq for ColorSpec

## Auto Trait Implementations

### impl RefUnwindSafe for ColorSpec

### impl Send for ColorSpec

### impl Sync for ColorSpec

### impl Unpin for ColorSpec

### impl UnwindSafe for ColorSpec

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