Skip to main content

Style

Struct Style 

Source
pub struct Style { /* private fields */ }
Expand description

A terminal style defining text effects and foreground/background colors.

When the color feature is enabled, this is backed by anstyle::Style which renders zero-allocation ANSI escape codes. When disabled, this is a zero-cost no-op type that emits nothing.

Implementations§

Source§

impl Style

Source

pub const fn new() -> Style

Create a new, unstyled style.

Source

pub const fn bold(self) -> Style

Set bold effect.

Source

pub const fn dimmed(self) -> Style

Set dimmed/faint effect.

Source

pub const fn italic(self) -> Style

Set italic effect.

Source

pub const fn underline(self) -> Style

Set underline effect.

Source

pub const fn fg_rgb(self, r: u8, g: u8, b: u8) -> Style

Set 24-bit Truecolor (RGB) foreground color.

Source

pub const fn fg_ansi256(self, code: u8) -> Style

Set 8-bit ANSI 256-color palette foreground color.

Source

pub const fn fg_ansi(self, color: AnsiColor) -> Style

Set 4-bit standard ANSI 16-color foreground color.

Source

pub fn is_plain(&self) -> bool

True if no styling effects or colors are configured.

Source

pub fn render(&self) -> impl Display

Render the ANSI sequence to activate this style.

Source

pub fn render_reset(&self) -> impl Display

Render the ANSI sequence to reset styles.

Source

pub const fn inner(&self) -> Style

Get the underlying anstyle::Style.

Source

pub fn to_ansi256(self) -> Style

Convert this style’s colors to ANSI 256 colors.

Source

pub fn to_ansi16(self) -> Style

Convert this style’s colors to standard 16 ANSI colors.

Source

pub fn to_monochrome(self) -> Style

Strip all foreground/background colors, preserving effects like Bold and Dimmed.

Trait Implementations§

Source§

impl Clone for Style

Source§

fn clone(&self) -> Style

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 Copy for Style

Source§

impl Debug for Style

Source§

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

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

impl Default for Style

Source§

fn default() -> Style

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

impl Eq for Style

Source§

impl From<Style> for Style

Available on crate feature color only.
Source§

fn from(inner: Style) -> Style

Converts to this type from the input type.
Source§

impl PartialEq for Style

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Style

Auto Trait Implementations§

§

impl Freeze for Style

§

impl RefUnwindSafe for Style

§

impl Send for Style

§

impl Sync for Style

§

impl Unpin for Style

§

impl UnsafeUnpin for Style

§

impl UnwindSafe for Style

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<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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.