Struct Emoji

pub struct Emoji<'a>(pub &'a str, pub &'a str);

An emoji with safety fallback.

The struct wraps an emoji and only renders it on platforms that actually support it. On non-supported platforms the fallback value is being rendered.

Support is determined by two factors:

1. The processes stdout has to be a tty.
2. Platform dependent:
   • macOS has emoji support by default
   • Unix systems have support if the active language supports them.
   • Windows machines running the new Terminal app support emojis.

Tuple Fields

0: &'a str

1: &'a str

Implementations

impl<'a> Emoji<'a>

pub const fn new(emoji: &'a str, fallback: &'a str) -> Self

Create a new emoji.

Arguments

• emoji: The unicode emoji to display.
• fallback: The fallback value to use on non-supported platforms.

Examples found in repository

examples/basic.rs (line 4)

fn main() {
    let crab = Emoji::new("🦀", "C");
    println!("{}", crab);
}

Trait Implementations

impl<'a> Clone for Emoji<'a>

fn clone(&self) -> Emoji<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Emoji<'a>

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

Formats the value using the given formatter.

impl Display for Emoji<'_>

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

Formats the value using the given formatter.

impl<'a> From<(&'a str, &'a str)> for Emoji<'a>

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

Converts to this type from the input type.

impl<'a> Hash for Emoji<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Emoji<'a>

fn eq(&self, other: &Emoji<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Copy for Emoji<'a>

impl<'a> Eq for Emoji<'a>

impl<'a> StructuralPartialEq for Emoji<'a>