Struct Html

pub struct Html<T: Write> { /* private fields */ }

An adaptor to allow writing stylish attributed data to an output stream by turning attributes into HTML elements.

let mut writer = stylish::Html::new(String::new());
stylish::write!(writer, "Hello {:(fg=red)}", "Ferris")?;
assert_eq!(
    writer.finish()?,
    "Hello <span style=color:red>Ferris</span>",
);

Implementations

impl<T: Write> Html<T>

pub fn new(inner: T) -> Self

Wrap the given output stream in this adaptor.

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

Inherent delegation to stylish::Write::write_fmt to not require a trait import.

pub fn finish(self) -> Result<T, Error>

Ensure the output stream is reset back to the default style and return it, if you don’t call this the stream will be left in whatever style the last output data was.

Trait Implementations

impl<T: Clone + Write> Clone for Html<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Write> Debug for Html<T>

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

Formats the value using the given formatter.

impl<T: Default + Write> Default for Html<T>

fn default() -> Html<T>

Returns the “default value” for a type.

impl<T: Write> Write for Html<T>

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_char(&mut self, c: char, style: Style) -> Result<(), Error>

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

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

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