Struct emojic::emojis::With

pub struct With<M, T: 'static> {
    pub default: T,
    /* private fields */
}

Customizable emoji composer.

This struct contains a set of Emoji which can be differentiated by an attribute M such as Tone, Gender, and Hair. Depending on the attribute type this struct provides customization functions such as With::tone, With::gender, and With::hair, respectively.

Notice unlike the WithNoDef, this struct has an default variant and thus Derefs to T, and implements Display if T does.

Fields

default: T

Implementations

impl<T> With<Tone, T>

Customizing by Tone.

Examples

assert_eq!(RAISING_HANDS.to_string(), "🙌"); // default, derefs directly to `Emoji`
assert_eq!(RAISING_HANDS.tone(Tone::Medium).to_string(), "🙌🏽"); // Toned variant

pub const fn tone(&self, tone: Tone) -> &T

impl<T> With<TonePair, T>

Customizing by TonePair.

Notice that Tone and (Tone, Tone) both implement Into<TonePair>.

Examples

assert_eq!(COUPLE_WITH_HEART.to_string(), "💑"); // default, derefs directly to `Emoji`
assert_eq!(COUPLE_WITH_HEART.tone(Tone::Medium).to_string(), "💑🏽"); // Same skin tone
assert_eq!(COUPLE_WITH_HEART.tone((Tone::Light, Tone::Dark)).to_string(), "🧑🏻‍❤️‍🧑🏿"); // Two different skin tones

pub fn tone(&self, tone: impl Into<TonePair>) -> &T

pub const fn tone_pair(&self, tone_pair: TonePair) -> &T

impl<T> With<Gender, T>

Customizing by Gender.

Examples

assert_eq!(ELF.to_string(), "🧝"); // default, derefs directly to `Emoji`
assert_eq!(ELF.gender(Gender::Female).to_string(), "🧝‍♀️"); // Variant with gender

pub const fn gender(&self, gender: Gender) -> &T

impl<T> With<Hair, T>

Customizing by Hair.

Examples

assert_eq!(PERSON.to_string(), "🧑"); // default, derefs directly to `Emoji`
assert_eq!(PERSON.hair(Hair::Red).to_string(), "🧑‍🦰"); // Variant with hair style

pub const fn hair(&self, hair: Hair) -> &T

impl<T> With<Pair, T>

Customizing by (gender) Pair.

Examples

assert_eq!(PERSON_HOLDING_HANDS.to_string(), "🧑‍🤝‍🧑"); // default, derefs directly to `Emoji`
assert_eq!(PERSON_HOLDING_HANDS.gender(Pair::Mixed).to_string(), "👫"); // With defined gender

pub fn gender(&self, pair: impl Into<Pair>) -> &T

pub const fn pair(&self, pair: Pair) -> &T

impl<T> With<OneOrTwo, T>

pub fn gender(&self, oot: impl Into<OneOrTwo>) -> &T

pub const fn pair(&self, oot: OneOrTwo) -> &T

impl<T> With<Family, T>

Customizing by Family.

Notice that various type that implement Into<Family> such as (Gender,Gender), and (Pair,Pair).

Examples

assert_eq!(FAMILY.to_string(), "👪"); // default, derefs directly to `Emoji`
assert_eq!(FAMILY.gender((Gender::Male, Gender::Female)).to_string(), "👨‍👧"); // Variant two single genders
assert_eq!(FAMILY.gender((Pair::Males, Pair::Females)).to_string(), "👨‍👨‍👧‍👧"); // Variant with two gender pairs
assert_eq!(FAMILY.gender(Gender::Female.with_children(Pair::Mixed)).to_string(), "👩‍👧‍👦"); // Variant based on composer chain

pub fn gender(&self, family: impl Into<Family>) -> &T

pub const fn family(&self, family: Family) -> &T

Trait Implementations

impl<M: Clone, T: Clone + 'static> Clone for With<M, T>

fn clone(&self) -> With<M, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug, T: Debug + 'static> Debug for With<M, T>

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

Formats the value using the given formatter.

impl<M, T> Deref for With<M, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<M, T: Display> Display for With<M, T>

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

Formats the value using the given formatter.

impl<M: Hash, T: Hash + 'static> Hash for With<M, T>

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<M: PartialEq, T: PartialEq + 'static> PartialEq<With<M, T>> for With<M, T>

fn eq(&self, other: &With<M, T>) -> bool

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

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

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

impl<M: Copy, T: Copy + 'static> Copy for With<M, T>

impl<M: Eq, T: Eq + 'static> Eq for With<M, T>

impl<M, T: 'static> StructuralEq for With<M, T>

impl<M, T: 'static> StructuralPartialEq for With<M, T>