Struct emojis::Emoji

source · [−]

pub struct Emoji { /* private fields */ }

Expand description

Represents an emoji.

See Unicode.org for more information.

Implementations

source

impl Emoji

source

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

Returns this emoji as a string.

Examples

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

source

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");

source

pub const fn unicode_version(&self) -> UnicodeVersion

Returns the Unicode version this emoji first appeared in.

Examples

use emojis::UnicodeVersion;

let villain = emojis::lookup("🦹").unwrap();
assert_eq!(villain.unicode_version(), UnicodeVersion::new(11, 0));

source

pub const fn group(&self) -> Group

Returns this emoji’s group.

Examples

use emojis::Group;

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

source

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());

source

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());

source

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());

source

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

source

impl AsRef<str> for Emoji

source

fn as_ref(&self) -> &str

Performs the conversion.

source

impl Debug for Emoji

source

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

Formats the value using the given formatter. Read more

source

impl Display for Emoji

source

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

Formats the value using the given formatter. Read more

source

impl Hash for Emoji

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl PartialEq<&'_ str> for Emoji

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl PartialEq<Emoji> for Emoji

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl PartialEq<str> for Emoji

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl Eq for Emoji

Auto Trait Implementations

impl RefUnwindSafe for Emoji

impl Send for Emoji

impl Sync for Emoji

impl Unpin for Emoji

impl UnwindSafe for Emoji

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

pub 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

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct emojis::Emoji

Implementations

impl Emoji

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

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

pub const fn unicode_version(&self) -> UnicodeVersion

pub const fn group(&self) -> Group

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

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

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

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

Trait Implementations

impl AsRef<str> for Emoji

fn as_ref(&self) -> &str

impl Debug for Emoji

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

impl Display for Emoji

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

impl Hash for Emoji

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

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

impl PartialEq<&'_ str> for Emoji

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

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

impl PartialEq<Emoji> for Emoji

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

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

impl PartialEq<str> for Emoji

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

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

impl Eq for Emoji

Auto Trait Implementations

impl RefUnwindSafe for Emoji

impl Send for Emoji

impl Sync for Emoji

impl Unpin for Emoji

impl UnwindSafe for Emoji

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

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

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

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

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

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

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

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

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

impl<T, U> TryFrom<U> for T where
U: Into<T>,

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