Struct emojis::Emoji

pub struct Emoji { /* fields omitted */ }

Represents an emoji.

See Unicode.org for more information.

Implementations

impl Emoji

pub const fn as_str(&self) -> &str

Returns this emoji as a string.

Examples

let rocket = emojis::lookup("🚀").unwrap();
assert_eq!(rocket.as_str(), "🚀")

pub const fn name(&self) -> &str

Returns the CLDR short name for this emoji.

Examples

let cool = emojis::lookup("😎").unwrap();
assert_eq!(cool.name(), "smiling face with sunglasses");

pub const fn group(&self) -> Group

Returns this emoji’s group.

Examples

let flag = emojis::lookup("🇿🇦").unwrap();
assert_eq!(flag.group(), Group::Flags);

pub fn skin_tone(&self) -> Option<SkinTone>

Returns the skin tone of this emoji.

Examples

use emojis::SkinTone;

let peace = emojis::lookup("✌️").unwrap();
assert_eq!(peace.skin_tone(), Some(SkinTone::Default));

let peace = emojis::lookup("✌🏽").unwrap();
assert_eq!(peace.skin_tone(), Some(SkinTone::Medium));

For emojis where skin tones are not applicable this will be None.

let cool = emojis::lookup("😎").unwrap();
assert!(cool.skin_tone().is_none());

pub fn skin_tones(&self) -> Option<impl Iterator<Item = &'static Self>>

Returns an iterator over the emoji and all the related skin tone emojis.

Examples

use emojis::Emoji;

let luck = emojis::lookup("🤞🏼").unwrap();
let tones: Vec<_> = luck.skin_tones().unwrap().map(Emoji::as_str).collect();
assert_eq!(tones, ["🤞", "🤞🏻", "🤞🏼", "🤞🏽", "🤞🏾", "🤞🏿"]);

For emojis where skin tones are not applicable this will return None.

let cool = emojis::lookup("😎").unwrap();
assert!(cool.skin_tones().is_none());

pub fn with_skin_tone(&self, skin_tone: SkinTone) -> Option<&'static Self>

Returns a version of this emoji that has the given skin tone.

Examples

use emojis::SkinTone;

let peace = emojis::lookup("🙌🏼")
    .unwrap()
    .with_skin_tone(SkinTone::MediumDark)
    .unwrap();
assert_eq!(peace, emojis::lookup("🙌🏾").unwrap());

For emojis where skin tones are not applicable this will be None.

use emojis::SkinTone;

let cool = emojis::lookup("😎").unwrap();
assert!(cool.with_skin_tone(SkinTone::Medium).is_none());

pub fn shortcode(&self) -> Option<&str>

Returns this emoji’s GitHub shortcode.

See gemoji for more information.

Examples

let thinking = emojis::lookup("🤔").unwrap();
assert_eq!(thinking.shortcode().unwrap(), "thinking");

Trait Implementations

impl AsRef<str> for Emoji

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Emoji

fn clone(&self) -> Emoji

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Emoji

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 Hash for Emoji

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<&'_ str> for Emoji

fn eq(&self, s: &&str) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<Emoji> for Emoji

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialEq<str> for Emoji

fn eq(&self, s: &str) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for Emoji

impl Eq for Emoji

impl StructuralEq for Emoji

impl StructuralPartialEq for Emoji