rustis::commands

Trait ConnectionCommands

Source 
pub trait ConnectionCommands<'a> {

Show 22 methods    // Provided methods
    fn auth<U, P>(
        self,
        username: Option<U>,
        password: P,
    ) -> PreparedCommand<'a, Self, ()>
       where Self: Sized,
             U: SingleArg,
             P: SingleArg { ... }
    fn client_caching(
        self,
        mode: ClientCachingMode,
    ) -> PreparedCommand<'a, Self, Option<()>>
       where Self: Sized { ... }
    fn client_getname<CN>(self) -> PreparedCommand<'a, Self, Option<CN>>
       where Self: Sized,
             CN: PrimitiveResponse + DeserializeOwned { ... }
    fn client_getredir(self) -> PreparedCommand<'a, Self, i64>
       where Self: Sized { ... }
    fn client_id(self) -> PreparedCommand<'a, Self, i64>
       where Self: Sized { ... }
    fn client_info(self) -> PreparedCommand<'a, Self, ClientInfo>
       where Self: Sized { ... }
    fn client_kill(
        self,
        options: ClientKillOptions,
    ) -> PreparedCommand<'a, Self, usize>
       where Self: Sized { ... }
    fn client_list(
        self,
        options: ClientListOptions,
    ) -> PreparedCommand<'a, Self, ClientListResult>
       where Self: Sized { ... }
    fn client_no_evict(self, no_evict: bool) -> PreparedCommand<'a, Self, ()>
       where Self: Sized { ... }
    fn client_pause(
        self,
        timeout: u64,
        mode: ClientPauseMode,
    ) -> PreparedCommand<'a, Self, ()>
       where Self: Sized { ... }
    fn client_reply(
        self,
        mode: ClientReplyMode,
    ) -> PreparedCommand<'a, Self, ()>
       where Self: Sized { ... }
    fn client_setname<CN>(
        self,
        connection_name: CN,
    ) -> PreparedCommand<'a, Self, ()>
       where Self: Sized,
             CN: SingleArg { ... }
    fn client_tracking(
        self,
        status: ClientTrackingStatus,
        options: ClientTrackingOptions,
    ) -> PreparedCommand<'a, Self, ()>
       where Self: Sized { ... }
    fn client_trackinginfo(
        self,
    ) -> PreparedCommand<'a, Self, ClientTrackingInfo>
       where Self: Sized { ... }
    fn client_unblock(
        self,
        client_id: i64,
        mode: ClientUnblockMode,
    ) -> PreparedCommand<'a, Self, bool>
       where Self: Sized { ... }
    fn client_unpause(self) -> PreparedCommand<'a, Self, bool>
       where Self: Sized { ... }
    fn echo<M, R>(self, message: M) -> PreparedCommand<'a, Self, R>
       where Self: Sized,
             M: SingleArg,
             R: PrimitiveResponse { ... }
    fn hello(
        self,
        options: HelloOptions,
    ) -> PreparedCommand<'a, Self, HelloResult>
       where Self: Sized { ... }
    fn ping<R>(self, options: PingOptions) -> PreparedCommand<'a, Self, R>
       where Self: Sized,
             R: PrimitiveResponse { ... }
    fn quit(self) -> PreparedCommand<'a, Self, ()>
       where Self: Sized { ... }
    fn reset(self) -> PreparedCommand<'a, Self, ()>
       where Self: Sized { ... }
    fn select(self, index: usize) -> PreparedCommand<'a, Self, ()>
       where Self: Sized { ... }

}
Expand description

A group of Redis commands related to connection management

§See Also

Redis Connection Management Commands

Provided Methods§

Source

fn auth<U, P>( self, username: Option<U>, password: P, ) -> PreparedCommand<'a, Self, ()>
where Self: Sized, U: SingleArg, P: SingleArg,

Authenticates the current connection.

§Errors

a Redis error if the password, or username/password pair, is invalid.

§See Also

https://redis.io/commands/auth/

Source

fn client_caching( self, mode: ClientCachingMode, ) -> PreparedCommand<'a, Self, Option<()>>
where Self: Sized,

This command controls the tracking of the keys in the next command executed by the connection, when tracking is enabled in OPTIN or OPTOUT mode.

§See Also

https://redis.io/commands/client-caching/

Source

fn client_getname<CN>(self) -> PreparedCommand<'a, Self, Option<CN>>
where Self: Sized, CN: PrimitiveResponse + DeserializeOwned,

Returns the name of the current connection as set by [CLIENT SETNAME].

§Return

The connection name, or a None if no name is set.

§See Also

https://redis.io/commands/client-getname/

Source

fn client_getredir(self) -> PreparedCommand<'a, Self, i64>
where Self: Sized,

This command returns the client ID we are redirecting our tracking notifications to.

§Return

the ID of the client we are redirecting the notifications to. The command returns -1 if client tracking is not enabled, or 0 if client tracking is enabled but we are not redirecting the notifications to any client.

§See Also

https://redis.io/commands/client-getredir/

Source

fn client_id(self) -> PreparedCommand<'a, Self, i64>
where Self: Sized,

The command just returns the ID of the current connection.

§Return

The id of the client.

§See Also

https://redis.io/commands/client-id/

Source

fn client_info(self) -> PreparedCommand<'a, Self, ClientInfo>
where Self: Sized,

The command returns information and statistics about the current client connection in a mostly human readable format.

§Return

A ClientInfo struct with additional properties

§See Also

https://redis.io/commands/client-info/

Source

fn client_kill( self, options: ClientKillOptions, ) -> PreparedCommand<'a, Self, usize>
where Self: Sized,

Closes a given clients connection based on a filter list

§Return

the number of clients killed.

§See Also

https://redis.io/commands/client-kill/

Source

fn client_list( self, options: ClientListOptions, ) -> PreparedCommand<'a, Self, ClientListResult>
where Self: Sized,

Returns information and statistics about the client connections server in a mostly human readable format.

§Return

A Vec of ClientInfo structs with additional properties

§See Also

https://redis.io/commands/client-list/

Source

fn client_no_evict(self, no_evict: bool) -> PreparedCommand<'a, Self, ()>
where Self: Sized,

sets the client eviction mode for the current connection.

§See Also

https://redis.io/commands/client-no-evict/

Source

fn client_pause( self, timeout: u64, mode: ClientPauseMode, ) -> PreparedCommand<'a, Self, ()>
where Self: Sized,

Connections control command able to suspend all the Redis clients for the specified amount of time (in milliseconds).

§See Also

https://redis.io/commands/client-pause/

Source

fn client_reply(self, mode: ClientReplyMode) -> PreparedCommand<'a, Self, ()>
where Self: Sized,

Sometimes it can be useful for clients to completely disable replies from the Redis server.

§See Also

https://redis.io/commands/client-reply/

Source

fn client_setname<CN>( self, connection_name: CN, ) -> PreparedCommand<'a, Self, ()>
where Self: Sized, CN: SingleArg,

Assigns a name to the current connection.

§See Also

https://redis.io/commands/client-setname/

Source

fn client_tracking( self, status: ClientTrackingStatus, options: ClientTrackingOptions, ) -> PreparedCommand<'a, Self, ()>
where Self: Sized,

This command enables the tracking feature of the Redis server, that is used for server assisted client side caching.

§See Also

https://redis.io/commands/client-tracking/

Source

fn client_trackinginfo(self) -> PreparedCommand<'a, Self, ClientTrackingInfo>
where Self: Sized,

This command enables the tracking feature of the Redis server, that is used for server assisted client side caching.

§See Also

https://redis.io/commands/client-tracking/

Source

fn client_unblock( self, client_id: i64, mode: ClientUnblockMode, ) -> PreparedCommand<'a, Self, bool>
where Self: Sized,

This command can unblock, from a different connection, a client blocked in a blocking operation, such as for instance BRPOP or XREAD or WAIT.

§Return
  • true - This command can unblock, from a different connection, a client blocked in a blocking operation, such as for instance BRPOP or XREAD or WAIT.
  • false - if the client wasn’t unblocked.
§See Also

https://redis.io/commands/client-unblock/

Source

fn client_unpause(self) -> PreparedCommand<'a, Self, bool>
where Self: Sized,

Used to resume command processing for all clients that were paused by client_pause.

§See Also

https://redis.io/commands/client-unpause/

Source

fn echo<M, R>(self, message: M) -> PreparedCommand<'a, Self, R>
where Self: Sized, M: SingleArg, R: PrimitiveResponse,

Returns message.

§See Also

https://redis.io/commands/echo/

Source

fn hello(self, options: HelloOptions) -> PreparedCommand<'a, Self, HelloResult>
where Self: Sized,

Switch to a different protocol, optionally authenticating and setting the connection’s name, or provide a contextual client report.

§See Also

https://redis.io/commands/hello/

Source

fn ping<R>(self, options: PingOptions) -> PreparedCommand<'a, Self, R>
where Self: Sized, R: PrimitiveResponse,

Returns PONG if no argument is provided, otherwise return a copy of the argument as a bulk.

§See Also

https://redis.io/commands/ping/

Source

fn quit(self) -> PreparedCommand<'a, Self, ()>
where Self: Sized,

Ask the server to close the connection.

§See Also

https://redis.io/commands/quit/

Source

fn reset(self) -> PreparedCommand<'a, Self, ()>
where Self: Sized,

This command performs a full reset of the connection’s server-side context, mimicking the effect of disconnecting and reconnecting again.

§See Also

https://redis.io/commands/reset/

Source

fn select(self, index: usize) -> PreparedCommand<'a, Self, ()>
where Self: Sized,

Select the Redis logical database having the specified zero-based numeric index.

§See Also

https://redis.io/commands/reset/

Implementors§

Source§

impl<'a> ConnectionCommands<'a> for &'a Client

Source§

impl<'a, 'b> ConnectionCommands<'a> for &'a mut Pipeline<'b>