Struct Memcached

pub struct Memcached { /* private fields */ }

Implementations

impl Memcached

pub fn new<R, W>(read: R, write: W) -> Self

where R: AsyncRead + Send + Sync + Unpin + 'static, W: AsyncWrite + Send + Sync + Unpin + 'static,

pub async fn stats(&mut self) -> Result<Stats, MtopError>

Get a Stats object with the current values of the interesting stats for the server.

pub async fn slabs(&mut self) -> Result<Slabs, MtopError>

Get a Slabs object with information about each set of Slabs maintained by the Memcached server. You can think of each Slab as a class of objects that are stored together in memory. Note that Slab IDs may not be contiguous based on the size of items actually stored by the server.

pub async fn items(&mut self) -> Result<SlabItems, MtopError>

Get a SlabsItems object with information about the SlabItem items stored in each slab class maintained by the Memcached server. The ID of each SlabItem corresponds to a Slab maintained by the server. Note that SlabItem IDs may not be contiguous based on the size of items actually stored by the server.

pub async fn metas(&mut self) -> Result<Vec<Meta>, MtopError>

Get a Meta object for every item in the cache which includes its key and expiration time as a UNIX timestamp. Expiration time will be -1 if the item was set with an infinite TTL.

pub async fn ping(&mut self) -> Result<(), MtopError>

Send a simple command to verify our connection to the server is working.

pub async fn flush_all( &mut self, wait: Option<Duration>, ) -> Result<(), MtopError>

Flush all entries in the cache, optionally after a delay. When a delay is used, the server will flush entries after a delay but the call will still return immediately.

pub async fn get( &mut self, keys: &[Key], ) -> Result<HashMap<String, Value>, MtopError>

Get a map of the requested keys and their corresponding Value in the cache including the key, flags, and data.

pub async fn incr(&mut self, key: &Key, delta: u64) -> Result<u64, MtopError>

Increment the value of a key by the given delta if the value is numeric returning the new value. Returns an error if the value is not numeric.

pub async fn decr(&mut self, key: &Key, delta: u64) -> Result<u64, MtopError>

Decrement the value of a key by the given delta if the value is numeric returning the new value with a minimum of 0. Returns an error if the value is not numeric.

pub async fn set<V>( &mut self, key: &Key, flags: u64, ttl: u32, data: V, ) -> Result<(), MtopError>

where V: AsRef<[u8]>,

Store the provided item in the cache, regardless of whether it already exists.

pub async fn add<V>( &mut self, key: &Key, flags: u64, ttl: u32, data: V, ) -> Result<(), MtopError>

where V: AsRef<[u8]>,

Store the provided item in the cache only if it does not already exist.

pub async fn replace<V>( &mut self, key: &Key, flags: u64, ttl: u32, data: V, ) -> Result<(), MtopError>

where V: AsRef<[u8]>,

Store the provided item in the cache only if it already exists.

pub async fn touch(&mut self, key: &Key, ttl: u32) -> Result<(), MtopError>

Update the TTL of an item in the cache if it exists, return an error otherwise.

pub async fn delete(&mut self, key: &Key) -> Result<(), MtopError>

Delete an item in the cache if it exists, return an error otherwise.

Trait Implementations

impl ClientFactory<Server, Memcached> for TcpClientFactory

async fn make(&self, server: &Server) -> Result<Memcached, MtopError>

Create a new client instance based on its ID.

impl Debug for Memcached

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

Formats the value using the given formatter.