Struct Formatter

pub struct Formatter<'a> { /* private fields */ }

A configured output stream.

A Formatter wraps a target output stream with a set of configuration options for formatting of data written to the stream. There is (currently) no public constructors for Formatter, an instance is created and passed to implementations of stylish::Display when they are used in the stylish macros.

Implementations

impl<'a> Formatter<'a>

pub fn with(&mut self, restyle: impl Restyle) -> Formatter<'_>

Create a sub-Formatter with some styles changed. This may be useful in implementations of stylish::Display to dynamically configure how some parts are formatted.

struct Name(&'static str);

impl stylish::Display for Name {
    fn fmt(&self, f: &mut stylish::Formatter<'_>) -> stylish::Result {
        let color = match self.0 {
            "Ferris" => stylish::Color::Red,
            "Gorris" => stylish::Color::Cyan,
            _ => stylish::Color::Default,
        };
        f.with(stylish::Foreground(color)).write_str(self.0)
    }
}

let formatted = stylish::html::format!("Hello {:s} and {:s}", Name("Ferris"), Name("Gorris"));
assert_eq!(
    formatted,
    "Hello <span style=color:red>Ferris</span> and <span style=color:cyan>Gorris</span>"
);

pub fn write_str(&mut self, s: &str) -> Result

Writes some data to the underlying output stream, using the current style.

struct Name(&'static str);

impl stylish::Display for Name {
    fn fmt(&self, f: &mut stylish::Formatter<'_>) -> stylish::Result {
        let color = match self.0 {
            "Ferris" => stylish::Color::Red,
            "Gorris" => stylish::Color::Cyan,
            _ => stylish::Color::Default,
        };
        f.with(stylish::Foreground(color)).write_str(self.0)
    }
}

let formatted = stylish::html::format!("Hello {:s} and {:s}", Name("Ferris"), Name("Gorris"));
assert_eq!(
    formatted,
    "Hello <span style=color:red>Ferris</span> and <span style=color:cyan>Gorris</span>"
);

pub fn write_fmt(&mut self, args: Arguments<'_>) -> Result

Writes some formatted data into this instance, overriding the current style as appropriate.

struct Name(&'static str);

impl stylish::Display for Name {
    fn fmt(&self, f: &mut stylish::Formatter<'_>) -> stylish::Result {
        match self.0 {
            "Ferris" => f.write_fmt(stylish::format_args!("{:(fg=red)}", self.0)),
            "Gorris" => f.write_fmt(stylish::format_args!("{:(fg=cyan)}", self.0)),
            _ => f.write_fmt(stylish::format_args!("{}", self.0)),
        }
    }
}

let formatted = stylish::html::format!("Hello {:s} and {:s}", Name("Ferris"), Name("Gorris"));
assert_eq!(
    formatted,
    "Hello <span style=color:red>Ferris</span> and <span style=color:cyan>Gorris</span>"
);

Trait Implementations

impl Debug for Formatter<'_>

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

Formats the value using the given formatter.

impl<'a> Write for Formatter<'a>

fn write_str(&mut self, s: &str, style: Style) -> Result

Writes a string slice with a particular Style into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result

Glue for usage of the stylish::write! macro with implementors of this trait.

fn write_char(&mut self, c: char, style: Style) -> Result

Writes a char with a particular Style into this writer, returning whether the write succeeded.

impl<'a> Write for Formatter<'a>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.