Struct EmojiDb

pub struct EmojiDb { /* private fields */ }

An emoji database

Implementations

impl EmojiDb

pub fn new() -> EmojiDb

Generates a new EmojiDb based off the database embedded in the library

pub fn from_cache<T: Read>(cache: &mut T) -> Result<EmojiDb, Box<dyn Error>>

Generates an EmojiDb that was saved to the given cache

pub fn from_web() -> Result<EmojiDb, Box<dyn Error>>

Generates a new EmojiDb based off data from the online repository maintained by the Emojibase project

Examples found in repository

examples/search_emojis.rs (line 6)

fn main() -> Result<(), Box<dyn Error>> {
    let db = EmojiDb::from_web()?;
    let searcher = EmojiSearcher::new(Rc::new(db));
    let items = searcher.search(std::env::args().nth(1).unwrap());
    for item in items {
        print!("{}\n", item.emoji);
    }
    Ok(())
}

pub fn save<T: Write>(&self, cache: &mut T) -> Result<(), Box<dyn Error>>

Saves the existing EmojiDb the provided cache

pub fn needs_update(&self) -> bool

Checks if a new version of the Emojibase project is available

pub fn emojis(&self) -> impl Iterator<Item = &Emoji>

Retrieves an iterator over all emojis in the db

pub fn version(&self) -> &str

Retrieves the corresponding Emojibase version

pub fn shortcode_sets(&self) -> &[HashMap<String, Vec<String>>]

Retrieves all shortcodes

Trait Implementations

impl Default for EmojiDb

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EmojiDb

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EmojiDb

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.