Struct paris::formatter::Formatter

source ·
pub struct Formatter<'a> { /* private fields */ }
Expand description

Heavier formatter that allows the possibility of custom styles in strings. That is the only reason this struct exists, if you don’t need custom things just use the colorize_string() function provided in the module.

Implementations§

source§

impl<'a> Formatter<'a>

source

pub fn new() -> Self

Create a new formatter with no custom styles defined

source

pub fn new_style(&mut self, key: &str, colors: Vec<&'a str>) -> &mut Self

Tell the formatter that you want a new style and what colors that style equates to so it knows what to replace it with when formatting

Example
use paris::formatter::Formatter;

let mut fmt = Formatter::new();
fmt.new_style("lol", vec!["green", "bold", "on_blue"]);

// '<lol>' is now a key that can be used in strings
source

pub fn colorize(&self, input: &str) -> String

Finds all keys in the given input. Keys meaning whatever the logger uses. Something that looks like <key>. And replaces all those keys with their color, style or icon equivalent.

Trait Implementations§

source§

impl<'a> Default for Formatter<'a>

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for Formatter<'a>

§

impl<'a> Send for Formatter<'a>

§

impl<'a> Sync for Formatter<'a>

§

impl<'a> Unpin for Formatter<'a>

§

impl<'a> UnwindSafe for Formatter<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · 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, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.