Struct Client

pub struct Client { /* private fields */ }

The client type.

Implementations

impl Client

The client acts as connector to the redis server. By itself it does not do much other than providing a convenient way to fetch a connection from it. In the future the plan is to provide a connection pool in the client.

When opening a client a URL in the following format should be used:

redis://host:port/db

Example usage::

let client = td_rredis::Client::open("redis://127.0.0.1/").unwrap();
let con = client.get_connection().unwrap();

pub fn open(info: &str) -> RedisResult<Client>

Connects to a redis server and returns a client. This does not actually open a connection yet but it does perform some basic checks on the URL that might make the operation fail.

Examples found in repository

examples/redis.rs (line 14)

fn test_get() -> redis::RedisResult<()> {
    let client = redis::Client::open("redis://127.0.0.1/").unwrap();
    let con = client.get_connection().unwrap();

    redis::cmd("DEL").arg("foo").execute(&con);
    for x in 0..600 {
        redis::cmd("SADD").arg("foo").arg(x).execute(&con);
    }
    Ok(())
}

pub fn get_connection(&self) -> RedisResult<Connection>

Instructs the client to actually connect to redis and returns a connection object. The connection object can be used to send commands to the server. This can fail with a variety of errors (like unreachable host) so it’s important that you handle those errors.

Examples found in repository

examples/redis.rs (line 15)

fn test_get() -> redis::RedisResult<()> {
    let client = redis::Client::open("redis://127.0.0.1/").unwrap();
    let con = client.get_connection().unwrap();

    redis::cmd("DEL").arg("foo").execute(&con);
    for x in 0..600 {
        redis::cmd("SADD").arg("foo").arg(x).execute(&con);
    }
    Ok(())
}

pub fn get_pubsub(&self) -> RedisResult<PubSub>

Returns a PubSub connection. A pubsub connection can be used to listen to messages coming in through the redis publish/subscribe system.

Note that redis’ pubsub operates across all databases.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.