Struct Style

pub struct Style { /* private fields */ }

ANSI Text styling

You can print a Style to render the corresponding ANSI code. Using the alternate flag # will render the ANSI reset code, if needed. Together, this makes it convenient to render styles using inline format arguments.

Examples

let style = anstyle::Style::new().bold();

let value = 42;
println!("{style}{value}{style:#}");

Implementations

impl Style

Core

pub const fn new() -> Self

No effects enabled

Examples

let style = anstyle::Style::new();

pub const fn fg_color(self, fg: Option<Color>) -> Self

Set foreground color

Examples

let style = anstyle::Style::new().fg_color(Some(anstyle::AnsiColor::Red.into()));

pub const fn bg_color(self, bg: Option<Color>) -> Self

Set background color

Examples

let style = anstyle::Style::new().bg_color(Some(anstyle::AnsiColor::Red.into()));

pub const fn underline_color(self, underline: Option<Color>) -> Self

Set underline color

Examples

let style = anstyle::Style::new().underline_color(Some(anstyle::AnsiColor::Red.into()));

pub const fn effects(self, effects: Effects) -> Self

Set text effects

Examples

let style = anstyle::Style::new().effects(anstyle::Effects::BOLD | anstyle::Effects::UNDERLINE);

pub fn render(self) -> impl Display + Copy

Render the ANSI code

Style also implements Display directly, so calling this method is optional.

pub fn write_to(self, write: &mut dyn Write) -> Result<()>

Available on crate feature std only.

Write the ANSI code

pub fn render_reset(self) -> impl Display + Copy

Renders the relevant Reset code

Unlike Reset::render, this will elide the code if there is nothing to reset.

pub fn write_reset_to(self, write: &mut dyn Write) -> Result<()>

Available on crate feature std only.

Write the relevant Reset code

Unlike Reset::render, this will elide the code if there is nothing to reset.

impl Style

Convenience

pub const fn bold(self) -> Self

Apply bold effect

Examples

let style = anstyle::Style::new().bold();

pub const fn dimmed(self) -> Self

Apply dimmed effect

Examples

let style = anstyle::Style::new().dimmed();

pub const fn italic(self) -> Self

Apply italic effect

Examples

let style = anstyle::Style::new().italic();

pub const fn underline(self) -> Self

Apply underline effect

Examples

let style = anstyle::Style::new().underline();

pub const fn blink(self) -> Self

Apply blink effect

Examples

let style = anstyle::Style::new().blink();

pub const fn invert(self) -> Self

Apply invert effect

Examples

let style = anstyle::Style::new().invert();

pub const fn hidden(self) -> Self

Apply hidden effect

Examples

let style = anstyle::Style::new().hidden();

pub const fn strikethrough(self) -> Self

Apply strikethrough effect

Examples

let style = anstyle::Style::new().strikethrough();

impl Style

Reflection

pub const fn get_fg_color(self) -> Option<Color>

Get the foreground color

pub const fn get_bg_color(self) -> Option<Color>

Get the background color

pub const fn get_underline_color(self) -> Option<Color>

pub const fn get_effects(self) -> Effects

pub const fn is_plain(self) -> bool

Check if no styling is enabled

Trait Implementations

impl BitOr<Effects> for Style

Examples

let style = anstyle::Style::new() | anstyle::Effects::BOLD.into();

type Output = Style

The resulting type after applying the | operator.

fn bitor(self, rhs: Effects) -> Self

Performs the | operation.

impl BitOrAssign<Effects> for Style

Examples

let mut style = anstyle::Style::new();
style |= anstyle::Effects::BOLD.into();

fn bitor_assign(&mut self, other: Effects)

Performs the |= operation.

impl Clone for Style

fn clone(&self) -> Style

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Style

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

Formats the value using the given formatter.

impl Default for Style

fn default() -> Style

Returns the “default value” for a type.

impl Display for Style

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

Formats the value using the given formatter.

impl From<Effects> for Style

Examples

let style: anstyle::Style = anstyle::Effects::BOLD.into();

fn from(effects: Effects) -> Self

Converts to this type from the input type.

impl Hash for Style

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Style

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<Effects> for Style

Examples

let effects = anstyle::Effects::BOLD;
assert_eq!(anstyle::Style::new().effects(effects), effects);
assert_ne!(anstyle::Effects::UNDERLINE | effects, effects);
assert_ne!(anstyle::RgbColor(0, 0, 0).on_default() | effects, effects);

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Style

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Style

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<Effects> for Style

Examples

let style = anstyle::Style::new().bold().underline() - anstyle::Effects::BOLD.into();

type Output = Style

The resulting type after applying the - operator.

fn sub(self, other: Effects) -> Self

Performs the - operation.

impl SubAssign<Effects> for Style

Examples

let mut style = anstyle::Style::new().bold().underline();
style -= anstyle::Effects::BOLD.into();

fn sub_assign(&mut self, other: Effects)

Performs the -= operation.

impl Copy for Style

impl Eq for Style

impl StructuralPartialEq for Style

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 14 bytes