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

pub 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

pub 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

pub 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

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct termcolor::ColorSpec

Implementations

impl ColorSpec

pub fn new() -> ColorSpec

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

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

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

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

pub fn bold(&self) -> bool

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

pub fn underline(&self) -> bool

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

pub fn intense(&self) -> bool

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

pub fn is_none(&self) -> bool

pub fn clear(&mut self)

Trait Implementations

impl Clone for ColorSpec

fn clone(&self) -> ColorSpec

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

impl Debug for ColorSpec

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

impl Default for ColorSpec

fn default() -> ColorSpec

impl PartialEq<ColorSpec> for ColorSpec

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

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

impl Eq for ColorSpec

impl StructuralEq for ColorSpec

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

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

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

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

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,