Struct rsmc_core::client::Client

pub struct Client<C: Connection, P: Compressor> { /* fields omitted */ }

A client manages connections to every node in a memcached cluster using consistent hashing to decide which connection to use based on the key.

Implementations

impl<C: Connection, P: Compressor> Client<C, P>

pub async fn new(config: ClientConfig<P>) -> Result<Self, Error>

Create a new client using the client config provided.

pub async fn get<K: AsRef<[u8]>, V: DeserializeOwned>(
    &mut self,
    key: K
) -> Result<Option<V>, Error>

Get a single value from memcached. Returns None when the key is not found (i.e., a miss).

pub async fn get_multi<'a, K: AsRef<[u8]>, V: DeserializeOwned>(
    &mut self,
    keys: &[K]
) -> BulkGetResponse<V>

Get multiple values from memcached at once. On success, it returns a tuple of (ok, err) responses. The error responses can be treated as misses, but should be logged for visibility. Lots of errors could be indicative of a serious problem.

pub async fn set<K: AsRef<[u8]>, V: Serialize + ?Sized>(
    &mut self,
    key: K,
    data: &V,
    expire: u32
) -> Result<(), Error>

Set a single key/value pair in memcached to expire at the desired time. A value of 0 means “never expire”, but the value could still be evicted by the LRU cache. Important: if expire is set to more than 30 days in the future, then memcached will treat it as a unix timestamp instead of a duration.

pub async fn set_multi<'a, V: Serialize, K: AsRef<[u8]> + Eq + Hash>(
    &mut self,
    data: HashMap<K, V>,
    expire: u32
) -> BulkUpdateResponse

Set multiple key/value pairs in memcached to expire at the desired time. A value of 0 means “never expire”, but the value could still be evicted by the LRU cache. Important: if expire is set to more than 30 days in the future, then memcached will treat it as a unix timestamp instead of a duration.

pub async fn delete<K: AsRef<[u8]>>(&mut self, key: K) -> Result<(), Error>

Delete a key from memcached. Does nothing if the key is not set.

pub async fn delete_multi<K: AsRef<[u8]>>(
    &mut self,
    keys: &[K]
) -> BulkUpdateResponse

Delete multiple keys from memcached. Does nothing when a key is unset.

Trait Implementations

impl<C: Clone + Connection, P: Clone + Compressor> Clone for Client<C, P>

fn clone(&self) -> Client<C, P>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug + Connection, P: Debug + Compressor> Debug for Client<C, P>

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

Formats the value using the given formatter.

impl<C, P> Manager<Client<C, P>, Error> for ClientConfig<P> where
    C: Connection,
    P: Compressor, 

fn create<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Client<C, P>, Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Create a new instance of T

fn recycle<'life0, 'life1, 'async_trait>(
    &'life0 self,
    client: &'life1 mut Client<C, P>
) -> Pin<Box<dyn Future<Output = RecycleResult<Error>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Try to recycle an instance of T returning None` if the object could not be recycled.