Struct fastly::handle::config_store::ConfigStoreHandle

pub struct ConfigStoreHandle { /* private fields */ }

A low-level interface to Config Store.

Methods here are typically exposed as the try_* APIs on crate::config_store::ConfigStore and should not be needed directly. Additionally, the get() method allows the caller to configure the size of the buffer used to receive lookup results from the host. The size of this buffer is typically managed by APIs exposed in crate::config_store::ConfigStore.

Implementations

impl ConfigStoreHandle

pub const INVALID: Self = _

An invalid handle.

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

Acquire a handle to an Config Store.

If a handle could not be acquired, an OpenError will be returned.

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

Lookup a value in this config store.

If successful, this function returns Ok(Some(_)) if an entry was found, or Ok(None) if no entry with the given key was found. If the lookup failed, a LookupError will be returned.

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

Return true if the config store contains an entry with the given key.

pub fn is_valid(&self) -> bool

Return true if the crate::config_store::ConfigStore handle is valid.

pub fn is_invalid(&self) -> bool

Return true if the crate::config_store::ConfigStore handle is invalid.

Trait Implementations

impl Debug for ConfigStoreHandle

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

Formats the value using the given formatter.

impl Hash for ConfigStoreHandle

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ConfigStoreHandle

fn eq(&self, other: &ConfigStoreHandle) -> bool

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

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 Eq for ConfigStoreHandle

impl StructuralPartialEq for ConfigStoreHandle