Dictionary

Return true if the dictionary contains an entry with the given key.

Examples

assert!(dictionary.contains("key"));

Panics

This may panic for any of the reasons that Dictionary::try_get would return an error.

Lookup a value in this dictionary.

If successful, this function returns Some(_) if an entry was found, or None if no entry with the given key was found.

Examples

1
2
3
4
5
6
7
8
9
10
11

assert_eq!(
     dictionary.get("bread"),
     Some(String::from("a usually baked and leavened food")),
);
assert_eq!(
    dictionary.get("freedom"),
    Some(String::from("the absence of necessity, coercion, or constraint")),
);

// Otherwise, `get` will return nothing.
assert!(dictionary.get("zzzzz").is_none());

Panics

This may panic for any of the reasons that Dictionary::try_get would return an error.

Open a dictionary, given its name.

Examples

let merriam = Dictionary::open("merriam webster");
let oed = Dictionary::open("oxford english dictionary");

Try to lookup a value in this dictionary.

If successful, this function returns Ok(Some(_)) if an entry was found, or Ok(None) if no entry with the given key was found. This function returns Err(_) if the lookup failed.

Examples

1
2
3
4
5
6
7
8
9
10
11
12

assert_eq!(
     dictionary.try_get("bread")?,
     Some(String::from("a usually baked and leavened food")),
);
assert_eq!(
    dictionary.try_get("freedom")?,
    Some(String::from("the absence of necessity, coercion, or constraint")),
);

// Otherwise, `try_get` will return nothing.
assert!(dictionary.try_get("zzzzz")?.is_none());
Ok(()) }

Try to open a dictionary, given its name.

Examples

let merriam = Dictionary::try_open("merriam webster")?;