Trait ConnectionCommands 

pub trait ConnectionCommands<'a>: Sized {
    // Provided methods
    fn auth(
        self,
        username: impl Serialize,
        password: impl Serialize,
    ) -> PreparedCommand<'a, Self, ()> { ... }
    fn client_caching(
        self,
        mode: ClientCachingMode,
    ) -> PreparedCommand<'a, Self, Option<()>> { ... }
    fn client_getname<R: Response>(self) -> PreparedCommand<'a, Self, R> { ... }
    fn client_getredir(self) -> PreparedCommand<'a, Self, i64> { ... }
    fn client_help<R: Response>(self) -> PreparedCommand<'a, Self, R> { ... }
    fn client_id(self) -> PreparedCommand<'a, Self, i64> { ... }
    fn client_info(self) -> PreparedCommand<'a, Self, ClientInfo> { ... }
    fn client_kill(
        self,
        options: ClientKillOptions<'_>,
    ) -> PreparedCommand<'a, Self, usize> { ... }
    fn client_list(
        self,
        options: ClientListOptions,
    ) -> PreparedCommand<'a, Self, ClientListResult> { ... }
    fn client_no_evict(self, no_evict: bool) -> PreparedCommand<'a, Self, ()> { ... }
    fn client_no_touch(self, no_touch: bool) -> PreparedCommand<'a, Self, ()> { ... }
    fn client_pause(
        self,
        timeout: u64,
        mode: ClientPauseMode,
    ) -> PreparedCommand<'a, Self, ()> { ... }
    fn client_reply(
        self,
        mode: ClientReplyMode,
    ) -> PreparedCommand<'a, Self, ()> { ... }
    fn client_setname(
        self,
        connection_name: impl Serialize,
    ) -> PreparedCommand<'a, Self, ()> { ... }
    fn client_setinfo(
        self,
        attr: ClientInfoAttribute,
        info: impl Serialize,
    ) -> PreparedCommand<'a, Self, ()> { ... }
    fn client_tracking(
        self,
        status: ClientTrackingStatus,
        options: ClientTrackingOptions,
    ) -> PreparedCommand<'a, Self, ()> { ... }
    fn client_trackinginfo(
        self,
    ) -> PreparedCommand<'a, Self, ClientTrackingInfo> { ... }
    fn client_unblock(
        self,
        client_id: i64,
        mode: ClientUnblockMode,
    ) -> PreparedCommand<'a, Self, bool> { ... }
    fn client_unpause(self) -> PreparedCommand<'a, Self, bool> { ... }
    fn echo<R: Response>(
        self,
        message: impl Serialize,
    ) -> PreparedCommand<'a, Self, R> { ... }
    fn hello(
        self,
        options: HelloOptions<'_>,
    ) -> PreparedCommand<'a, Self, HelloResult> { ... }
    fn ping<R: Response>(
        self,
        message: impl Serialize,
    ) -> PreparedCommand<'a, Self, R> { ... }
    fn quit(self) -> PreparedCommand<'a, Self, ()> { ... }
    fn reset(self) -> PreparedCommand<'a, Self, ()> { ... }
    fn select(self, index: usize) -> PreparedCommand<'a, Self, ()> { ... }
}

A group of Redis commands related to connection management

See Also

Redis Connection Management Commands

Provided Methods

fn auth( self, username: impl Serialize, password: impl Serialize, ) -> PreparedCommand<'a, Self, ()>

Authenticates the current connection.

This method supports both the legacy authentication (password only) and the Redis 6+ ACL authentication (username and password).

• username - The username. Pass () to use the default user (legacy behavior).
• password - The password.

Errors

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

See Also

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

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

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/

fn client_getname<R: Response>(self) -> PreparedCommand<'a, Self, R>

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/

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

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/

fn client_help<R: Response>(self) -> PreparedCommand<'a, Self, R>

The command returns a helpful text describing the different CLIENT subcommands.

Return

An array of strings.

Example

let result: Vec<String> = client.client_help().await?;
assert!(result.iter().any(|e| e == "HELP"));

See Also

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

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

The command just returns the ID of the current connection.

Return

The id of the client.

See Also

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

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

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/

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

Closes a given clients connection based on a filter list

Return

the number of clients killed.

See Also

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

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

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/

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

sets the client eviction mode for the current connection.

See Also

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

fn client_no_touch(self, no_touch: bool) -> PreparedCommand<'a, Self, ()>

The command controls whether commands sent by the client will alter the LRU/LFU of the keys they access. If ON, the client will not change LFU/LRU stats. If OFF or send TOUCH, client will change LFU/LRU stats just as a normal client.

Return

The () type

Example

client.client_no_touch(true).await?;
client.client_no_touch(false).await?;
}

See Also

https://redis.io/docs/latest/commands/client-no-touch/

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

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/

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

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

See Also

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

fn client_setname( self, connection_name: impl Serialize, ) -> PreparedCommand<'a, Self, ()>

Assigns a name to the current connection.

See Also

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

fn client_setinfo( self, attr: ClientInfoAttribute, info: impl Serialize, ) -> PreparedCommand<'a, Self, ()>

Assigns various info attributes to the current connection. There is no limit to the length of these attributes. However it is not possible to use spaces, newlines, or other non-printable characters. Look changes with commands client_list or client_info.

Example

client
    .client_setinfo(ClientInfoAttribute::LibName, "rustis")
    .await?;
client
    .client_setinfo(ClientInfoAttribute::LibVer, "0.13.3")
    .await?;

let attrs: String = client.send(cmd("CLIENT").arg("INFO"), None).await?.to()?;

assert!(attrs.contains("lib-name=rustis lib-ver=0.13.3"));

See Also

https://redis.io/docs/latest/commands/client-setinfo/

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

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/

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

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/

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

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/

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

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

See Also

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

fn echo<R: Response>( self, message: impl Serialize, ) -> PreparedCommand<'a, Self, R>

Returns message.

See Also

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

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

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/

fn ping<R: Response>( self, message: impl Serialize, ) -> PreparedCommand<'a, Self, R>

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

• message - if the argument is provided, the command returns a copy of the argument. pass () to ignore.

See Also

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

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

Ask the server to close the connection.

See Also

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

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

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/

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

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

See Also

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

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

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

impl<'a> ConnectionCommands<'a> for &'a mut Pipeline<'_>