pub struct ColoredFormatter<F>
where F: Formatter,
{ /* private fields */ }
Expand description

ColoredFormatter decorates a Formatter with color defined in Styler

Implementations§

source§

impl<F> ColoredFormatter<F>
where F: Formatter,

source

pub fn new(formatter: F) -> Self

source

pub fn with_styler(formatter: F, styler: Styler) -> Self

source

pub fn to_colored_json_auto<T>(self, value: &T) -> Result<String>
where T: Serialize,

source

pub fn to_colored_json<T>(self, value: &T, mode: ColorMode) -> Result<String>
where T: Serialize,

source

pub fn write_colored_json<W, T>( self, value: &T, writer: &mut W, mode: ColorMode ) -> Result<(), Error>
where W: Write, T: Serialize,

Trait Implementations§

source§

impl<F> Clone for ColoredFormatter<F>
where F: Formatter + Clone,

source§

fn clone(&self) -> ColoredFormatter<F>

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<F> Formatter for ColoredFormatter<F>
where F: Formatter,

source§

fn write_null<W>(&mut self, writer: &mut W) -> Result<()>
where W: Write + ?Sized,

Writes a null value to the specified writer.
source§

fn write_bool<W>(&mut self, writer: &mut W, value: bool) -> Result<()>
where W: Write + ?Sized,

Writes a true or false value to the specified writer.
source§

fn write_i8<W>(&mut self, writer: &mut W, value: i8) -> Result<()>
where W: Write + ?Sized,

Writes an integer value like -123 to the specified writer.
source§

fn write_i16<W>(&mut self, writer: &mut W, value: i16) -> Result<()>
where W: Write + ?Sized,

Writes an integer value like -123 to the specified writer.
source§

fn write_i32<W>(&mut self, writer: &mut W, value: i32) -> Result<()>
where W: Write + ?Sized,

Writes an integer value like -123 to the specified writer.
source§

fn write_i64<W>(&mut self, writer: &mut W, value: i64) -> Result<()>
where W: Write + ?Sized,

Writes an integer value like -123 to the specified writer.
source§

fn write_u8<W>(&mut self, writer: &mut W, value: u8) -> Result<()>
where W: Write + ?Sized,

Writes an integer value like 123 to the specified writer.
source§

fn write_u16<W>(&mut self, writer: &mut W, value: u16) -> Result<()>
where W: Write + ?Sized,

Writes an integer value like 123 to the specified writer.
source§

fn write_u32<W>(&mut self, writer: &mut W, value: u32) -> Result<()>
where W: Write + ?Sized,

Writes an integer value like 123 to the specified writer.
source§

fn write_u64<W>(&mut self, writer: &mut W, value: u64) -> Result<()>
where W: Write + ?Sized,

Writes an integer value like 123 to the specified writer.
source§

fn write_f32<W>(&mut self, writer: &mut W, value: f32) -> Result<()>
where W: Write + ?Sized,

Writes a floating point value like -31.26e+12 to the specified writer.
source§

fn write_f64<W>(&mut self, writer: &mut W, value: f64) -> Result<()>
where W: Write + ?Sized,

Writes a floating point value like -31.26e+12 to the specified writer.
source§

fn write_number_str<W>(&mut self, writer: &mut W, value: &str) -> Result<()>
where W: Write + ?Sized,

Writes a number that has already been rendered to a string.
source§

fn begin_string<W>(&mut self, writer: &mut W) -> Result<()>
where W: Write + ?Sized,

Called before each series of write_string_fragment and write_char_escape. Writes a " to the specified writer.
source§

fn end_string<W>(&mut self, writer: &mut W) -> Result<()>
where W: Write + ?Sized,

Called after each series of write_string_fragment and write_char_escape. Writes a " to the specified writer.
source§

fn write_string_fragment<W>( &mut self, writer: &mut W, fragment: &str ) -> Result<()>
where W: Write + ?Sized,

Writes a string fragment that doesn’t need any escaping to the specified writer.
source§

fn begin_array<W>(&mut self, writer: &mut W) -> Result<()>
where W: Write + ?Sized,

Called before every array. Writes a [ to the specified writer.
source§

fn end_array<W>(&mut self, writer: &mut W) -> Result<()>
where W: Write + ?Sized,

Called after every array. Writes a ] to the specified writer.
source§

fn begin_array_value<W>(&mut self, writer: &mut W, first: bool) -> Result<()>
where W: Write + ?Sized,

Called before every array value. Writes a , if needed to the specified writer.
source§

fn end_array_value<W>(&mut self, writer: &mut W) -> Result<()>
where W: Write + ?Sized,

Called after every array value.
source§

fn begin_object<W>(&mut self, writer: &mut W) -> Result<()>
where W: Write + ?Sized,

Called before every object. Writes a { to the specified writer.
source§

fn end_object<W>(&mut self, writer: &mut W) -> Result<()>
where W: Write + ?Sized,

Called after every object. Writes a } to the specified writer.
source§

fn begin_object_key<W>(&mut self, writer: &mut W, first: bool) -> Result<()>
where W: Write + ?Sized,

Called before every object key.
source§

fn end_object_key<W>(&mut self, writer: &mut W) -> Result<()>
where W: Write + ?Sized,

Called after every object key. A : should be written to the specified writer by either this method or begin_object_value.
source§

fn begin_object_value<W>(&mut self, writer: &mut W) -> Result<()>
where W: Write + ?Sized,

Called before every object value. A : should be written to the specified writer by either this method or end_object_key.
source§

fn end_object_value<W>(&mut self, writer: &mut W) -> Result<()>
where W: Write + ?Sized,

Called after every object value.
source§

fn write_raw_fragment<W>( &mut self, writer: &mut W, fragment: &str ) -> Result<()>
where W: Write + ?Sized,

Writes a raw JSON fragment that doesn’t need any escaping to the specified writer.
source§

fn write_char_escape<W>( &mut self, writer: &mut W, char_escape: CharEscape ) -> Result<(), Error>
where W: Write + ?Sized,

Writes a character escape code to the specified writer.

Auto Trait Implementations§

§

impl<F> Freeze for ColoredFormatter<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for ColoredFormatter<F>
where F: RefUnwindSafe,

§

impl<F> Send for ColoredFormatter<F>
where F: Send,

§

impl<F> Sync for ColoredFormatter<F>
where F: Sync,

§

impl<F> Unpin for ColoredFormatter<F>
where F: Unpin,

§

impl<F> UnwindSafe for ColoredFormatter<F>
where F: UnwindSafe,

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> 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> Paint for T
where T: ?Sized,

source§

fn fg(&self, value: Color) -> Painted<&T>

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();
source§

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

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

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

fn fixed(&self, color: u8) -> Painted<&T>

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

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

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn bg(&self, value: Color) -> Painted<&T>

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();
source§

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

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

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

fn on_fixed(&self, color: u8) -> Painted<&T>

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

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

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn attr(&self, value: Attribute) -> Painted<&T>

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();
source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn quirk(&self, value: Quirk) -> Painted<&T>

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();
source§

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

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

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

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

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

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

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

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

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

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

👎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());
source§

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

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

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

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

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

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

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

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

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

fn whenever(&self, value: Condition) -> Painted<&T>

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);
source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
source§

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

§

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

§

type Error = Infallible

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

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

Performs the conversion.
source§

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

§

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.