Enum paris::LogIcon

pub enum LogIcon {
    Tick,
    Cross,
    Info,
    Warning,
    Heart,
    None,
}

Contains definitions for icons that can be used in the terminal. See this github repo for an entire list. Use this in combination with printing macros.

Variants

Tick

A check mark, use when things go well

Example

use paris::LogIcon;

println!("{} Everything went well", LogIcon::Tick);
// ✔ Everything went well

Cross

A cross, use when things go bad, or be creative

Example

println!("{} Oops, try again!", LogIcon::Cross);
// ✖ Oops, try again!

Info

A fancy 'i', for information

Example

println!("{} In Switzerland it is illegal to own just one guinea pig", LogIcon::Info);
// ℹ In Switzerland it is illegal to own just one guinea pig.

Warning

A triangle with an exclamation mark in it, dangerous

Example

println!("{} Things are starting to catch fire!", LogIcon::Warning);
// ⚠ Things are starting to catch fire!

Heart

❤️🦄

Example

// You get it...

None

No icon. Empty string. Nada. This is here to return something for the parser when it doesn't match any given keys

Methods

impl LogIcon

pub fn to_str<'a>(&self) -> &'a str

Match the enum value and return the equivalent icon. See this github repo for all icons

Trait Implementations

impl Display for LogIcon

fn fmt(&self, f: &mut Formatter) -> DisplayResult

Formats the value using the given formatter.

impl<'a> From<&'a str> for LogIcon

fn from(s: &'a str) -> Self

Performs the conversion.

impl FromStr for LogIcon

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.