Struct redis::Client[][src]

pub struct Client { /* fields omitted */ }
Expand description

The client type.

Implementations

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 = redis::Client::open("redis://127.0.0.1/").unwrap();
let con = client.get_connection().unwrap();

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.

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.

Instructs the client to actually connect to redis with specified timeout 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.

Returns a reference of client connection info object.

To enable async support you need to chose one of the supported runtimes and active its corresponding feature: tokio-comp or async-std-comp

This is supported on crate feature aio only.

Returns an async connection from the client.

This is supported on crate features aio and tokio-comp only.

Returns an async connection from the client.

This is supported on crate features aio and async-std-comp only.

Returns an async connection from the client.

This is supported on crate feature aio and (crate features tokio-comp or async-std-comp) only.

Returns an async connection from the client.

This is supported on crate features aio and tokio-comp only.

Returns an async multiplexed connection from the client.

A multiplexed connection can be cloned, allowing requests to be be sent concurrently on the same underlying connection (tcp/unix socket).

This is supported on crate features aio and async-std-comp only.

Returns an async multiplexed connection from the client.

A multiplexed connection can be cloned, allowing requests to be be sent concurrently on the same underlying connection (tcp/unix socket).

This is supported on crate features aio and tokio-comp only.

Returns an async multiplexed connection from the client and a future which must be polled to drive any requests submitted to it (see get_multiplexed_tokio_connection).

A multiplexed connection can be cloned, allowing requests to be be sent concurrently on the same underlying connection (tcp/unix socket).

This is supported on crate features aio and async-std-comp only.

Returns an async multiplexed connection from the client and a future which must be polled to drive any requests submitted to it (see get_multiplexed_tokio_connection).

A multiplexed connection can be cloned, allowing requests to be be sent concurrently on the same underlying connection (tcp/unix socket).

This is supported on crate features aio and connection-manager only.

Returns an async ConnectionManager from the client.

The connection manager wraps a MultiplexedConnection. If a command to that connection fails with a connection error, then a new connection is established in the background and the error is returned to the caller.

This means that on connection loss at least one command will fail, but the connection will be re-established automatically if possible. Please refer to the ConnectionManager docs for detailed reconnecting behavior.

A connection manager can be cloned, allowing requests to be be sent concurrently on the same underlying connection (tcp/unix socket).

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Sends an already encoded (packed) command into the TCP socket and reads the single response from it. Read more

Sends multiple already encoded (packed) command into the TCP socket and reads count responses from it. This is used to implement pipelining. Read more

Returns the database this connection is bound to. Note that this information might be unreliable because it’s initially cached and also might be incorrect if the connection like object is not actually connected. Read more

Check that all connections it has are available (PING internally).

Returns the connection status. Read more

Sends a Cmd into the TCP socket and reads a single response from it.

Formats the value using the given formatter. Read more

The connection type this manager deals with.

The error type returned by Connections.

Attempts to create a new connection.

Determines if the connection is still connected to the database. Read more

Quickly determines if the connection is no longer usable. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.