Struct fastly::Dictionary

pub struct Dictionary { /* private fields */ }

A Compute@Edge Dictionary.

Implementations

impl Dictionary

pub fn open(name: &str) -> Self

Open a dictionary, given its name.

Examples

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

pub fn try_open(name: &str) -> Result<Self, OpenError>

Try to open a dictionary, given its name.

Examples

let merriam = Dictionary::try_open("merriam webster").unwrap();

pub fn get(&self, key: &str) -> Option<String>

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

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.

pub fn try_get(&self, key: &str) -> Result<Option<String>, LookupError>

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

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

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

pub fn contains(&self, key: &str) -> bool

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.