[−][src]Struct redis::Client
The client type.
Implementations
impl Client
[src]
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();
pub fn open<T: IntoConnectionInfo>(params: T) -> RedisResult<Client>
[src]
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.
pub fn get_connection(&self) -> RedisResult<Connection>
[src]
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.
pub fn get_connection_with_timeout(
&self,
timeout: Duration
) -> RedisResult<Connection>
[src]
&self,
timeout: Duration
) -> RedisResult<Connection>
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.
impl Client
[src]
To enable async support you need to chose one of the supported runtimes and active its
corresponding feature: tokio-comp
or async-std-comp
pub async fn get_async_connection<'_>(&'_ self) -> RedisResult<Connection>
[src]
aio
only.Returns an async connection from the client.
pub async fn get_tokio_connection<'_>(&'_ self) -> RedisResult<Connection>
[src]
aio
and tokio-comp
only.Returns an async connection from the client.
pub async fn get_async_std_connection<'_>(&'_ self) -> RedisResult<Connection>
[src]
aio
and async-std-comp
only.Returns an async connection from the client.
pub async fn get_multiplexed_async_connection<'_>(
&'_ self
) -> RedisResult<MultiplexedConnection>
[src]
&'_ self
) -> RedisResult<MultiplexedConnection>
aio
and (crate features tokio-comp
or async-std-comp
) only.Returns an async connection from the client.
pub async fn get_multiplexed_tokio_connection<'_>(
&'_ self
) -> RedisResult<MultiplexedConnection>
[src]
&'_ self
) -> RedisResult<MultiplexedConnection>
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).
pub async fn get_multiplexed_async_std_connection<'_>(
&'_ self
) -> RedisResult<MultiplexedConnection>
[src]
&'_ self
) -> RedisResult<MultiplexedConnection>
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).
pub async fn create_multiplexed_tokio_connection<'_>(
&'_ self
) -> RedisResult<(MultiplexedConnection, impl Future<Output = ()>)>
[src]
&'_ self
) -> RedisResult<(MultiplexedConnection, impl Future<Output = ()>)>
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).
pub async fn create_multiplexed_async_std_connection<'_>(
&'_ self
) -> RedisResult<(MultiplexedConnection, impl Future<Output = ()>)>
[src]
&'_ self
) -> RedisResult<(MultiplexedConnection, impl Future<Output = ()>)>
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).
pub async fn get_tokio_connection_manager<'_>(
&'_ self
) -> RedisResult<ConnectionManager>
[src]
&'_ self
) -> RedisResult<ConnectionManager>
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
impl Clone for Client
[src]
impl ConnectionLike for Client
[src]
pub fn req_packed_command(&mut self, cmd: &[u8]) -> RedisResult<Value>
[src]
pub fn req_packed_commands(
&mut self,
cmd: &[u8],
offset: usize,
count: usize
) -> RedisResult<Vec<Value>>
[src]
&mut self,
cmd: &[u8],
offset: usize,
count: usize
) -> RedisResult<Vec<Value>>
pub fn get_db(&self) -> i64
[src]
pub fn check_connection(&mut self) -> bool
[src]
pub fn is_open(&self) -> bool
[src]
impl Debug for Client
[src]
impl ManageConnection for Client
[src]
type Connection = Connection
The connection type this manager deals with.
type Error = RedisError
The error type returned by Connection
s.
pub fn connect(&self) -> Result<Self::Connection, Self::Error>
[src]
pub fn is_valid(&self, conn: &mut Self::Connection) -> Result<(), Self::Error>
[src]
pub fn has_broken(&self, conn: &mut Self::Connection) -> bool
[src]
Auto Trait Implementations
impl RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl UnwindSafe for Client
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,