Struct ClientState

pub struct ClientState { /* private fields */ }

A struct which goal is to give a generic access to attach any state to a client instance

It is internally used to cache RedisGraph metadata.

Implementations

impl ClientState

pub fn get_state<S: Default + Send + Sync + 'static>( &self, key: &str, ) -> Result<Option<&S>>

Get state with a specific type S for a specific key

Return

Casted state to the required type or Ok(None) if key has not been found.

If the state does not already exists, it is created on the fly by calling S::default()

Errors

An error if an entry has been found for the key but this entry cannot be downcasted to the required type.

pub fn get_state_mut<S: Default + Send + Sync + 'static>( &mut self, key: &str, ) -> Result<&mut S>

Get state with a specific type S for a specific key

Return

Casted state to the required type.

If the state does not already exists, it is created on the fly by calling S::default()

Errors

An error if an entry has been found for the key but this entry cannot be downcasted to the required type.

Trait Implementations

impl Default for ClientState

fn default() -> ClientState

Returns the “default value” for a type.