Rule in redis::acl - Rust
Description: 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.

Skip to main content

## Rule

# Enum Rule

Source

    #[non_exhaustive]pub enum Rule {
    Show 22 variants    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,
        Channel(String),
        ResetChannels,
        Selector(Vec<Rule>),
        Reset,
        Other(String),
    }

Available on crate feature `acl` only.
Expand description

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 (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future 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.

§

### Channel(String)

Pattern for pub/sub channels (returned prefixed with `&` by Redis)

§

### ResetChannels

Reset Channels

§

### Selector(Vec<Rule>)

Selector entries (returned by Redis under `(selectors)`). Only supported in Redis 7.2 and later

§

### 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§

Source§

### impl Debug for Rule

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl PartialEq for Rule

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

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

### impl ToRedisArgs for Rule

Source§

#### 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. Read more
Source§

#### 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. Read more
Source§

#### 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`).
Source§

#### fn num_of_args(&self) -> usize

Returns the number of arguments this value will generate. Read more
Source§

### impl Eq for Rule

Source§

### impl StructuralPartialEq for Rule

## Auto Trait Implementations§

§

### impl Freeze for Rule

§

### impl RefUnwindSafe for Rule

§

### impl Send for Rule

§

### impl Sync for Rule

§

### impl Unpin for Rule

§

### impl UnwindSafe for Rule

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

§

### impl<T> PolicyExt for T
where T: ?Sized,

§

#### fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] only if `self` and `other` return `Action::Follow`. Read more
§

#### fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] if either `self` or `other` returns `Action::Follow`. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

### impl<T> ErasedDestructor for T
where T: 'static,

§

### impl<T> MaybeSendSync for T