Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

High-level Redis client

Automatically handles:

  • Topology detection (Standalone vs Cluster)
  • MOVED and ASK redirects in cluster mode
  • Connection pooling (multiplexed or traditional)
  • Reconnection with exponential backoff

Implementations§

Source§

impl Client

Source

pub async fn connect(config: ConnectionConfig) -> RedisResult<Self>

Connect to Redis with the given configuration

This will automatically detect whether you’re connecting to a standalone Redis server or a Redis Cluster.

§Example
use redis_oxide::{Client, ConnectionConfig};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let config = ConnectionConfig::new("redis://localhost:6379");
    let client = Client::connect(config).await?;
    Ok(())
}
Source

pub async fn get(&self, key: impl Into<String>) -> RedisResult<Option<String>>

Get the value of a key

Source

pub async fn set( &self, key: impl Into<String>, value: impl Into<String>, ) -> RedisResult<bool>

Set the value of a key

Source

pub async fn set_ex( &self, key: impl Into<String>, value: impl Into<String>, expiration: Duration, ) -> RedisResult<bool>

Set the value of a key with expiration

Source

pub async fn set_nx( &self, key: impl Into<String>, value: impl Into<String>, ) -> RedisResult<bool>

Set the value of a key only if it doesn’t exist

Source

pub async fn del(&self, keys: Vec<String>) -> RedisResult<i64>

Delete one or more keys

Source

pub async fn exists(&self, keys: Vec<String>) -> RedisResult<i64>

Check if one or more keys exist

Source

pub async fn expire( &self, key: impl Into<String>, duration: Duration, ) -> RedisResult<bool>

Set a key’s time to live in seconds

Source

pub async fn ttl(&self, key: impl Into<String>) -> RedisResult<Option<i64>>

Get the time to live for a key

Source

pub async fn incr(&self, key: impl Into<String>) -> RedisResult<i64>

Increment the integer value of a key by one

Source

pub async fn decr(&self, key: impl Into<String>) -> RedisResult<i64>

Decrement the integer value of a key by one

Source

pub async fn incr_by( &self, key: impl Into<String>, increment: i64, ) -> RedisResult<i64>

Increment the integer value of a key by the given amount

Source

pub async fn decr_by( &self, key: impl Into<String>, decrement: i64, ) -> RedisResult<i64>

Decrement the integer value of a key by the given amount

Source

pub fn topology_type(&self) -> TopologyType

Get the topology type

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more