Enum redis::acl::Rule

pub enum Rule {
    On,
    Off,
    AddCommand(String),
    RemoveCommand(String),
    AddCategory(String),
    RemoveCategory(String),
    AllCommands,
    NoCommands,
    AddPass(String),
    RemovePass(String),
    AddHashedPass(String),
    RemoveHashedPass(String),
    NoPass,
    ResetPass,
    Pattern(String),
    AllKeys,
    ResetKeys,
    Reset,
    Other(String),
}

Available on crate feature acl only.

ACL rules are used in order to activate or remove a flag, or to perform a given change to the user ACL, which under the hood are just single words.

Variants

On

Enable the user: it is possible to authenticate as this user.

Off

Disable the user: it’s no longer possible to authenticate with this user, however the already authenticated connections will still work.

AddCommand(String)

Add the command to the list of commands the user can call.

RemoveCommand(String)

Remove the command to the list of commands the user can call.

AddCategory(String)

Add all the commands in such category to be called by the user.

RemoveCategory(String)

Remove the commands from such category the client can call.

AllCommands

Alias for +@all. Note that it implies the ability to execute all the future commands loaded via the modules system.

NoCommands

Alias for -@all.

AddPass(String)

Add this password to the list of valid password for the user.

RemovePass(String)

Remove this password from the list of valid passwords.

AddHashedPass(String)

Add this SHA-256 hash value to the list of valid passwords for the user.

RemoveHashedPass(String)

Remove this hash value from from the list of valid passwords

NoPass

All the set passwords of the user are removed, and the user is flagged as requiring no password: it means that every password will work against this user.

ResetPass

Flush the list of allowed passwords. Moreover removes the nopass status.

Pattern(String)

Add a pattern of keys that can be mentioned as part of commands.

AllKeys

Alias for ~*.

ResetKeys

Flush the list of allowed keys patterns.

Reset

Performs the following actions: resetpass, resetkeys, off, -@all. The user returns to the same state it has immediately after its creation.

Other(String)

Raw text of ACL rule that not enumerated above.

Trait Implementations

impl Debug for Rule

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

Formats the value using the given formatter.

impl PartialEq<Rule> for Rule

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl ToRedisArgs for Rule

fn write_redis_args<W>(&self, out: &mut W)where
    W: ?Sized + RedisWrite,

This writes the value into a vector of bytes. Each item is a single argument. Most items generate a single item.

fn to_redis_args(&self) -> Vec<Vec<u8>>

This converts the value into a vector of bytes. Each item is a single argument. Most items generate a vector of a single item.

fn describe_numeric_behavior(&self) -> NumericBehavior

Returns an information about the contained value with regards to it’s numeric behavior in a redis context. This is used in some high level concepts to switch between different implementations of redis functions (for instance INCR vs INCRBYFLOAT).

fn is_single_arg(&self) -> bool

Returns an indiciation if the value contained is exactly one argument. It returns false if it’s zero or more than one. This is used in some high level functions to intelligently switch between GET and MGET variants.

impl Eq for Rule

impl StructuralEq for Rule

impl StructuralPartialEq for Rule