Emoji constants for your rusty strings. This crate is inspired by the Go library emoji written by @enescakir.
Notice that this file uses the actual Unicode emojis to given visual example of the result. However, depending on the font and support on your device, not all emojis might be represented correctly, especially the newer ones.
toml
[dependencies]
emojic = "0.3"
```rust use emojic::Gender; use emojic::Pair; use emojic::Tone; use emojic::flat::*;
println!("Hello {}", WAVINGHAND); println!( "I'm {} from {}", TECHNOLOGIST.gender(Gender::Male), FLAGTURKEY ); println!( "Different skin tones default {} light {} dark {}", THUMBSUP, OKHAND.tone(Tone::Light), CALLMEHAND.tone(Tone::Dark) ); println!( "Multiple skin tones: default: {}, same: {} different: {}", PERSONHOLDINGHANDS, PERSONHOLDINGHANDS.tone(Tone::Medium), PERSONHOLDINGHANDS.tone((Tone::Light, Tone::Dark)) ); println!( "Different sexes: default: {} male: {}, female: {}", GENIE, GENIE.gender(Gender::Male), GENIE.gender(Gender::Female), ); println!( "Mixing attributes: men & light: {} and women & drak: {}", PERSONTIPPINGHAND.gender(Gender::Male).tone(Tone::Light), PERSONTIPPINGHAND.gender(Gender::Female).tone(Tone::Dark), ); ```
text
Hello đ
I'm đ¨âđť from đšđˇ
Different skin tones default đ light đđť dark đ¤đż
Multiple skin tones: default: đ§âđ¤âđ§, same: đ§đ˝âđ¤âđ§đ˝ different: đ§đťâđ¤âđ§đż
Different sexes: default: đ§ male: đ§ââď¸, female: đ§ââď¸
Mixing attributes: men & light: đđťââď¸ and women & drak: đđżââď¸
This crate contains emojis constants based on the Full Emoji List v13.1. Including its categorization:
rust
assert_eq!(
emojic::grouped::people_and_body::hands::OPEN_HANDS, //đ¤˛
emojic::flat::OPEN_HANDS, //đ¤˛
);
As well as iterators to list all the emojis in each group and subgroup:
rust
// Iterates all hand emoji: đ, đ, đ¤, đ, đ¤˛, đ
emojic::grouped::people_and_body::hands::base_emojis()
Additional, it has functions to generate (arbitrary) country and regional flags.
rust
// đ´ó §ó ˘ó Ľó Žó §ó ż ⊠đ´ó §ó ˘ó łó Łó ´ó ż â đŹđ§ â đŞđş
println!("{} ⊠{} â {} â {}",
regional_flag("GB-ENG"),
regional_flag("GB-SCT"),
country_flag("GB"),
country_flag("EU"),
)
Finally, this crate has allows parsing emoji aliases from the github/gemoji
list via parse_alias.
rust
parse_alias(":+1:") // đ
parse_alias(":100:") // đŻ
parse_alias(":woman_astronaut:") // đŠâđ
And it has also an utility to parse and replace these emoji aliases in text via
parse_text.
rust
// a 𼪠consists of đ, đĽ, and some đ§
parse_text("a :sandwich: consists of :bread:, :bacon:, and some :cheese:")
For more examples have a look at the examples folder.
This crate is no_std by default, means it should be usable in WASM and other restricted
platforms. However, some additional functions need the alloc crate (normally part of std),
thus it is enabled by default.
default: (implies alloc) \
Automatically enabled if not opt-out:
toml
[dependencies.emojic]
version = "0.3"
default-features = false
alloc: (implies hashbrown and lazy_static) \
Requires a global allocator,
enables some additional functions: the parse_text function and the
ad-hoc flag-functions (country_flag & regional_flag)
(the flag constants are unaffected).
Notice, that lazy_static, by default, pulls-in std to use mutices for waiting.
This is good if you do have std available, and bad if not. However, the alternative is
to instruct lazy_static to use spinlocks instead. Yet, since crate-features are unified by
Cargo, it would be bad for all user that have std, to requiring it by default.
Instead, if you want to use this alloc feature, but you don't have std
(e.g. in your binary crate), you can simply add lazy_static yourself, and make it to use
spinlocks, which will apply globally. E.g. add to your Cargo.toml:
toml
[dependencies.lazy_static]
version = "1.4"
features = ["spin_no_std"]
Also see: https://github.com/rust-lang-nursery/lazy-static.rs/issues/150
Licensed under MIT License (LICENSE).
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the MIT license, shall be licensed as above, without any additional terms or conditions.