Struct String

pub struct String { /* private fields */ }

Available on crate feature alloc only.

An attributed version of alloc::string::String which has a specific Style associated with each character.

The main interfaces to create an instance of this are stylish::format! and impl Write for String, and to inspect the content impl Display for String.

You can create an instance via stylish::format!:

let _: stylish::String = stylish::format!("Hello {:(fg=green)}!", "World");

You can append extra data via stylish::write!:

use stylish::Write;

let mut s = stylish::String::new();
stylish::write!(s, "{:(fg=magenta)}", "fuchsia")?;

To use the attributed data you must then write this string to a sink using the {:s} trait-selector.

use stylish::Write;

let mut s = stylish::format!("Hello {:(fg=green)}!", "World");
stylish::write!(s, " Is it {:(fg=magenta)} or?", "fuchsia")?;

assert_eq!(
    stylish::html::format!("{:s}", s),
    "Hello <span style=color:green>World</span>! \
    Is it <span style=color:magenta>fuchsia</span> or?",
);

Implementations

impl String

pub fn new() -> Self

Create an empty String.

assert_eq!(stylish::html::format!("{:s}", stylish::String::new()), "");

Trait Implementations

impl Clone for String

fn clone(&self) -> String

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for String

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

Formats the value using the given formatter.

impl Default for String

fn default() -> String

Returns the “default value” for a type.

impl Display for String

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

Formats the value using the given formatter.

impl Write for String

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

Writes a char 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.