Struct Style

pub struct Style {
    pub foreground: Option<Colour>,
    pub background: Option<Colour>,
    pub is_bold: bool,
    pub is_dimmed: bool,
    pub is_italic: bool,
    pub is_underline: bool,
    pub is_blink: bool,
    pub is_reverse: bool,
    pub is_hidden: bool,
    pub is_strikethrough: bool,
}

A style is a collection of properties that can format a string using ANSI escape codes.

Examples

use yansi_term::{Style, Colour};

let style = Style::new().bold().on(Colour::Black);
println!("{}", style.paint("Bold on black"));

Fields

foreground: Option<Colour>

The style’s foreground colour, if it has one.

background: Option<Colour>

The style’s background colour, if it has one.

is_bold: bool

Whether this style is bold.

is_dimmed: bool

Whether this style is dimmed.

is_italic: bool

Whether this style is italic.

is_underline: bool

Whether this style is underlined.

is_blink: bool

Whether this style is blinking.

is_reverse: bool

Whether this style has reverse colours.

is_hidden: bool

Whether this style is hidden.

is_strikethrough: bool

Whether this style is struckthrough.

Implementations

impl Style

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

Write any bytes that go before a piece of text to the given writer.

pub fn write_reset(f: &mut Formatter<'_>) -> Result

Write any bytes that go after a piece of text to the given writer.

impl Style

pub fn new() -> Style

Creates a new Style with no properties set.

Examples

use yansi_term::Style;

let style = Style::new();
println!("{}", style.paint("hi"));

pub fn bold(self) -> Self

Returns a Style with the bold property set.

Examples

use yansi_term::Style;

let style = Style::new().bold();
println!("{}", style.paint("hey"));

pub fn dimmed(self) -> Self

Returns a Style with the dimmed property set.

Examples

use yansi_term::Style;

let style = Style::new().dimmed();
println!("{}", style.paint("sup"));

pub fn italic(self) -> Self

Returns a Style with the italic property set.

Examples

use yansi_term::Style;

let style = Style::new().italic();
println!("{}", style.paint("greetings"));

pub fn underline(self) -> Self

Returns a Style with the underline property set.

Examples

use yansi_term::Style;

let style = Style::new().underline();
println!("{}", style.paint("salutations"));

pub fn blink(self) -> Self

Returns a Style with the blink property set.

Examples

use yansi_term::Style;

let style = Style::new().blink();
println!("{}", style.paint("wazzup"));

pub fn reverse(self) -> Self

Returns a Style with the reverse property set.

Examples

use yansi_term::Style;

let style = Style::new().reverse();
println!("{}", style.paint("aloha"));

pub fn hidden(self) -> Self

Returns a Style with the hidden property set.

Examples

use yansi_term::Style;

let style = Style::new().hidden();
println!("{}", style.paint("ahoy"));

pub fn strikethrough(self) -> Self

Returns a Style with the strikethrough property set.

Examples

use yansi_term::Style;

let style = Style::new().strikethrough();
println!("{}", style.paint("yo"));

pub fn fg(self, foreground: Colour) -> Self

Returns a Style with the foreground colour property set.

Examples

use yansi_term::{Style, Colour};

let style = Style::new().fg(Colour::Yellow);
println!("{}", style.paint("hi"));

pub fn on(self, background: Colour) -> Self

Returns a Style with the background colour property set.

Examples

use yansi_term::{Style, Colour};

let style = Style::new().on(Colour::Blue);
println!("{}", style.paint("eyyyy"));

pub fn is_plain(&self) -> bool

Return true if this Style has no actual styles, and can be written without any control characters.

Examples

use yansi_term::Style;

assert_eq!(true,  Style::default().is_plain());
assert_eq!(false, Style::default().bold().is_plain());

impl Style

pub fn paint<'a>(self, input: &'a str) -> impl Display + 'a

Paints the given text with this style

pub fn paint_fn<F: FnOnce(&mut Formatter<'_>) -> Result>( self, f: F, ) -> impl Display

Paints the given format function with this style

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a duplicate 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 From<Colour> for Style

fn from(colour: Colour) -> Style

You can turn a Colour into a Style with the foreground colour set with the From trait.

use yansi_term::{Style, Colour};
let green_foreground = Style::default().fg(Colour::Green);
assert_eq!(green_foreground, Colour::Green.normal());
assert_eq!(green_foreground, Colour::Green.into());
assert_eq!(green_foreground, Style::from(Colour::Green));

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

impl StructuralPartialEq for Style