Struct yansi::Painted

pub struct Painted<T> {
    pub value: T,
    pub style: Style,
}

An arbitrary value with a Style applied to it.

A Painted can be directly formatted. This results in the internal value being formatted as specified and ANSI code styling sequences corresponding to style being prefixed and suffixed as necessary. Both the global and local Condition affects whether styling sequences are actually emitted: both must evaluated to true. Otherwise, no styling sequences are emitted.

use yansi::{Paint, Condition};

println!("Hello, {}!", "world".red().underline().blink());
// > Hello, world! # world is red, underlined, and blinking

let v = format!("{}", "world".red().underline().blink());
assert_eq!(v, "\u{1b}[4;5;31mworld\u{1b}[0m");
println!("{}", v); // > world # world is red, underlined, and blinking

let v = format!("{}", "world".red().underline().blink().whenever(Condition::NEVER));
assert_eq!(v, "world");

Fields

value: T

The value to be styled.

style: Style

The style to apply.

Implementations

impl<T> Painted<T>

pub const fn new(value: T) -> Painted<T>

Create a new Painted with a default Style.

Example

use yansi::Painted;

let painted = Painted::new("hello");
assert_eq!(painted.style, yansi::Style::new());

pub const fn fg(self, value: Color) -> Self

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();

pub const fn primary(self) -> Self

Returns self with the fg() set to Color::Primary.

Example

println!("{}", value.primary());

pub const fn fixed(self, color: u8) -> Self

Returns self with the fg() set to Color::Fixed.

Example

println!("{}", value.fixed(color));

pub const fn rgb(self, r: u8, g: u8, b: u8) -> Self

Returns self with the fg() set to Color::Rgb.

Example

println!("{}", value.rgb(r, g, b));

pub const fn black(self) -> Self

Returns self with the fg() set to Color::Black.

Example

println!("{}", value.black());

pub const fn red(self) -> Self

Returns self with the fg() set to Color::Red.

Example

println!("{}", value.red());

pub const fn green(self) -> Self

Returns self with the fg() set to Color::Green.

Example

println!("{}", value.green());

pub const fn yellow(self) -> Self

Returns self with the fg() set to Color::Yellow.

Example

println!("{}", value.yellow());

pub const fn blue(self) -> Self

Returns self with the fg() set to Color::Blue.

Example

println!("{}", value.blue());

pub const fn magenta(self) -> Self

Returns self with the fg() set to Color::Magenta.

Example

println!("{}", value.magenta());

pub const fn cyan(self) -> Self

Returns self with the fg() set to Color::Cyan.

Example

println!("{}", value.cyan());

pub const fn white(self) -> Self

Returns self with the fg() set to Color::White.

Example

println!("{}", value.white());

pub const fn bright_black(self) -> Self

Returns self with the fg() set to Color::BrightBlack.

Example

println!("{}", value.bright_black());

pub const fn bright_red(self) -> Self

Returns self with the fg() set to Color::BrightRed.

Example

println!("{}", value.bright_red());

pub const fn bright_green(self) -> Self

Returns self with the fg() set to Color::BrightGreen.

Example

println!("{}", value.bright_green());

pub const fn bright_yellow(self) -> Self

Returns self with the fg() set to Color::BrightYellow.

Example

println!("{}", value.bright_yellow());

pub const fn bright_blue(self) -> Self

Returns self with the fg() set to Color::BrightBlue.

Example

println!("{}", value.bright_blue());

pub const fn bright_magenta(self) -> Self

Returns self with the fg() set to Color::BrightMagenta.

Example

println!("{}", value.bright_magenta());

pub const fn bright_cyan(self) -> Self

Returns self with the fg() set to Color::BrightCyan.

Example

println!("{}", value.bright_cyan());

pub const fn bright_white(self) -> Self

Returns self with the fg() set to Color::BrightWhite.

Example

println!("{}", value.bright_white());

pub const fn bg(self, value: Color) -> Self

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();

pub const fn on_primary(self) -> Self

Returns self with the bg() set to Color::Primary.

Example

println!("{}", value.on_primary());

pub const fn on_fixed(self, color: u8) -> Self

Returns self with the bg() set to Color::Fixed.

Example

println!("{}", value.on_fixed(color));

pub const fn on_rgb(self, r: u8, g: u8, b: u8) -> Self

Returns self with the bg() set to Color::Rgb.

Example

println!("{}", value.on_rgb(r, g, b));

pub const fn on_black(self) -> Self

Returns self with the bg() set to Color::Black.

Example

println!("{}", value.on_black());

pub const fn on_red(self) -> Self

Returns self with the bg() set to Color::Red.

Example

println!("{}", value.on_red());

pub const fn on_green(self) -> Self

Returns self with the bg() set to Color::Green.

Example

println!("{}", value.on_green());

pub const fn on_yellow(self) -> Self

Returns self with the bg() set to Color::Yellow.

Example

println!("{}", value.on_yellow());

pub const fn on_blue(self) -> Self

Returns self with the bg() set to Color::Blue.

Example

println!("{}", value.on_blue());

pub const fn on_magenta(self) -> Self

Returns self with the bg() set to Color::Magenta.

Example

println!("{}", value.on_magenta());

pub const fn on_cyan(self) -> Self

Returns self with the bg() set to Color::Cyan.

Example

println!("{}", value.on_cyan());

pub const fn on_white(self) -> Self

Returns self with the bg() set to Color::White.

Example

println!("{}", value.on_white());

pub const fn on_bright_black(self) -> Self

Returns self with the bg() set to Color::BrightBlack.

Example

println!("{}", value.on_bright_black());

pub const fn on_bright_red(self) -> Self

Returns self with the bg() set to Color::BrightRed.

Example

println!("{}", value.on_bright_red());

pub const fn on_bright_green(self) -> Self

Returns self with the bg() set to Color::BrightGreen.

Example

println!("{}", value.on_bright_green());

pub const fn on_bright_yellow(self) -> Self

Returns self with the bg() set to Color::BrightYellow.

Example

println!("{}", value.on_bright_yellow());

pub const fn on_bright_blue(self) -> Self

Returns self with the bg() set to Color::BrightBlue.

Example

println!("{}", value.on_bright_blue());

pub const fn on_bright_magenta(self) -> Self

Returns self with the bg() set to Color::BrightMagenta.

Example

println!("{}", value.on_bright_magenta());

pub const fn on_bright_cyan(self) -> Self

Returns self with the bg() set to Color::BrightCyan.

Example

println!("{}", value.on_bright_cyan());

pub const fn on_bright_white(self) -> Self

Returns self with the bg() set to Color::BrightWhite.

Example

println!("{}", value.on_bright_white());

pub const fn attr(self, value: Attribute) -> Self

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();

pub const fn bold(self) -> Self

Returns self with the attr() set to Attribute::Bold.

Example

println!("{}", value.bold());

pub const fn dim(self) -> Self

Returns self with the attr() set to Attribute::Dim.

Example

println!("{}", value.dim());

pub const fn italic(self) -> Self

Returns self with the attr() set to Attribute::Italic.

Example

println!("{}", value.italic());

pub const fn underline(self) -> Self

Returns self with the attr() set to Attribute::Underline.

Example

println!("{}", value.underline());

pub const fn blink(self) -> Self

Returns self with the attr() set to Attribute::Blink.

Example

println!("{}", value.blink());

pub const fn rapid_blink(self) -> Self

Returns self with the attr() set to Attribute::RapidBlink.

Example

println!("{}", value.rapid_blink());

pub const fn invert(self) -> Self

Returns self with the attr() set to Attribute::Invert.

Example

println!("{}", value.invert());

pub const fn conceal(self) -> Self

Returns self with the attr() set to Attribute::Conceal.

Example

println!("{}", value.conceal());

pub const fn strike(self) -> Self

Returns self with the attr() set to Attribute::Strike.

Example

println!("{}", value.strike());

pub const fn quirk(self, value: Quirk) -> Self

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();

pub const fn mask(self) -> Self

Returns self with the quirk() set to Quirk::Mask.

Example

println!("{}", value.mask());

pub const fn wrap(self) -> Self

Returns self with the quirk() set to Quirk::Wrap.

Example

println!("{}", value.wrap());

pub const fn linger(self) -> Self

Returns self with the quirk() set to Quirk::Linger.

Example

println!("{}", value.linger());

pub const fn clear(self) -> Self

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to Quirk::Clear.

Example

println!("{}", value.clear());

pub const fn resetting(self) -> Self

Returns self with the quirk() set to Quirk::Resetting.

Example

println!("{}", value.resetting());

pub const fn bright(self) -> Self

Returns self with the quirk() set to Quirk::Bright.

Example

println!("{}", value.bright());

pub const fn on_bright(self) -> Self

Returns self with the quirk() set to Quirk::OnBright.

Example

println!("{}", value.on_bright());

pub const fn whenever(self, value: Condition) -> Self

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);

Trait Implementations

impl<T: Binary> Binary for Painted<T>

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

Formats the value using the given formatter.

impl<T: Clone> Clone for Painted<T>

fn clone(&self) -> Painted<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Painted<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for Painted<T>

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

Formats the value using the given formatter.

impl<T> From<Painted<T>> for Style

fn from(painted: Painted<T>) -> Self

Converts to this type from the input type.

impl<T: LowerExp> LowerExp for Painted<T>

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

Formats the value using the given formatter.

impl<T: LowerHex> LowerHex for Painted<T>

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

Formats the value using the given formatter.

impl<T: Octal> Octal for Painted<T>

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

Formats the value using the given formatter.

impl<T: Pointer> Pointer for Painted<T>

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

Formats the value using the given formatter.

impl<T: UpperExp> UpperExp for Painted<T>

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

Formats the value using the given formatter.

impl<T: UpperHex> UpperHex for Painted<T>

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

Formats the value using the given formatter.

impl<T: Copy> Copy for Painted<T>