Enum CommandFlag

pub enum CommandFlag {
    Write,
    ReadOnly,
    Admin,
    DenyOOM,
    DenyScript,
    AllowLoading,
    PubSub,
    Random,
    AllowStale,
    NoMonitor,
    NoSlowlog,
    Fast,
    GetkeysApi,
    NoCluster,
    NoAuth,
    MayReplicate,
    NoMandatoryKeys,
    Blocking,
    AllowBusy,
    GetchannelsApi,
    Internal,
}

Variants

Write

The command may modify the data set (it may also read from it).

ReadOnly

The command returns data from keys but never writes.

Admin

The command is an administrative command (may change replication or perform similar tasks).

DenyOOM

The command may use additional memory and should be denied during out of memory conditions.

DenyScript

Don’t allow this command in Lua scripts.

AllowLoading

Allow this command while the server is loading data. Only commands not interacting with the data set should be allowed to run in this mode. If not sure don’t use this flag.

PubSub

The command publishes things on Pub/Sub channels.

Random

👎Deprecated: Declaring a command as ‘random’ can be done using command tips, see https://redis.io/topics/command-tips.

The command may have different outputs even starting from the same input arguments and key values. Starting from Redis 7.0 this flag has been deprecated. Declaring a command as “random” can be done using command tips, see https://redis.io/topics/command-tips.

AllowStale

The command is allowed to run on slaves that don’t serve stale data. Don’t use if you don’t know what this means.

NoMonitor

Don’t propagate the command on monitor. Use this if the command has sensitive data among the arguments.

NoSlowlog

Don’t log this command in the slowlog. Use this if the command has sensitive data among the arguments.

Fast

The command time complexity is not greater than O(log(N)) where N is the size of the collection or anything else representing the normal scalability issue with the command.

GetkeysApi

The command implements the interface to return the arguments that are keys. Used when start/stop/step is not enough because of the command syntax.

NoCluster

The command should not register in Redis Cluster since is not designed to work with it because, for example, is unable to report the position of the keys, programmatically creates key names, or any other reason.

NoAuth

This command can be run by an un-authenticated client. Normally this is used by a command that is used to authenticate a client.

MayReplicate

This command may generate replication traffic, even though it’s not a write command.

NoMandatoryKeys

All the keys this command may take are optional

Blocking

The command has the potential to block the client.

AllowBusy

Permit the command while the server is blocked either by a script or by a slow module command, see RM_Yield.

GetchannelsApi

The command implements the interface to return the arguments that are channels.

Internal

Internal command, one that should not be exposed to the user connections. For example, module commands that are called by the modules, commands that do not perform ACL validations (relying on earlier checks)

Implementations

impl CommandFlag

pub fn as_str(&self) -> &str

Trait Implementations

impl Clone for CommandFlag

fn clone(&self) -> CommandFlag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandFlag

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

Formats the value using the given formatter.

impl Display for CommandFlag

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

Formats the value using the given formatter.

impl Hash for CommandFlag

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CommandFlag

fn cmp(&self, other: &CommandFlag) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CommandFlag

fn eq(&self, other: &CommandFlag) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CommandFlag

fn partial_cmp(&self, other: &CommandFlag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for CommandFlag

impl Eq for CommandFlag

impl StructuralPartialEq for CommandFlag