Struct redis_module::ContextFlags

pub struct ContextFlags(_);

Implementations

impl ContextFlags

pub const LUA: Self = _

The command is running in the context of a Lua script

pub const MULTI: Self = _

The command is running inside a Redis transaction

pub const MASTER: Self = _

The instance is a master

pub const SLAVE: Self = _

The instance is a SLAVE

pub const READONLY: Self = _

The instance is read-only (usually meaning it’s a slave as well)

pub const CLUSTER: Self = _

The instance is running in cluster mode

pub const AOF: Self = _

The instance has AOF enabled

pub const RDB: Self = _

The instance has RDB enabled

pub const MAXMEMORY: Self = _

The instance has Maxmemory set

pub const EVICTED: Self = _

Maxmemory is set and has an eviction policy that may delete keys

pub const OOM: Self = _

Redis is out of memory according to the maxmemory flag.

pub const OOM_WARNING: Self = _

Less than 25% of memory available according to maxmemory.

pub const REPLICATED: Self = _

The command was sent over the replication link.

pub const LOADING: Self = _

Redis is currently loading either from AOF or RDB.

pub const REPLICA_IS_STALE: Self = _

The replica has no link with its master

pub const REPLICA_IS_CONNECTING: Self = _

The replica is trying to connect with the master

pub const REPLICA_IS_TRANSFERRING: Self = _

The replica is receiving an RDB file from its master.

pub const REPLICA_IS_ONLINE: Self = _

The replica is online, receiving updates from its master

pub const ACTIVE_CHILD: Self = _

There is currently some background process active.

pub const IS_CHILD: Self = _

Redis is currently running inside background child process.

pub const MULTI_DIRTY: Self = _

The next EXEC will fail due to dirty CAS (touched keys).

pub const DENY_BLOCKING: Self = _

The current client does not allow blocking, either called from within multi, lua, or from another module using RM_Call

pub const FLAGS_RESP3: Self = _

The current client uses RESP3 protocol

pub const ASYNC_LOADING: Self = _

Redis is currently async loading database for diskless replication.

impl ContextFlags

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> c_int

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: c_int) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: c_int) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const fn from_bits_retain(bits: c_int) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub fn from_name(name: &str) -> Option<Self>

Get the value for a flag from its stringified name.

Names are case-sensitive, so must correspond exactly to the identifier given to the flag.

pub const fn iter(&self) -> Iter

Iterate over enabled flag values.

pub const fn iter_names(&self) -> IterRaw

Iterate over enabled flag values with their stringified names.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for ContextFlags

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

Formats the value using the given formatter.

impl BitAnd<ContextFlags> for ContextFlags

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

Returns the intersection between the two sets of flags.

type Output = ContextFlags

The resulting type after applying the & operator.

impl BitAndAssign<ContextFlags> for ContextFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitFlags for ContextFlags

type Bits = i32

The underlying integer type.

type Iter = Iter

An iterator over enabled flags in an instance of the type.

type IterNames = IterRaw

An iterator over the raw names and bits for enabled flags in an instance of the type.

fn empty() -> Self

Returns an empty set of flags.

fn all() -> Self

Returns the set containing all flags.

fn bits(&self) -> c_int

Returns the raw value of the flags currently stored.

fn from_bits(bits: c_int) -> Option<ContextFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

fn from_bits_truncate(bits: c_int) -> ContextFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

fn from_bits_retain(bits: c_int) -> ContextFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

fn from_name(name: &str) -> Option<ContextFlags>

Get the flag for a particular name.

fn iter(&self) -> Self::Iter

Iterate over enabled flag values.

fn iter_names(&self) -> Self::IterNames

Iterate over the raw names and bits for enabled flag values.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

fn intersects(&self, other: ContextFlags) -> bool

Returns true if there are flags common to both self and other.

fn contains(&self, other: ContextFlags) -> bool

Returns true if all of the flags in other are contained within self.

fn insert(&mut self, other: ContextFlags)

Inserts the specified flags in-place.

fn remove(&mut self, other: ContextFlags)

Removes the specified flags in-place.

fn toggle(&mut self, other: ContextFlags)

Toggles the specified flags in-place.

fn set(&mut self, other: ContextFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl BitOr<ContextFlags> for ContextFlags

fn bitor(self, other: ContextFlags) -> Self

Returns the union of the two sets of flags.

type Output = ContextFlags

The resulting type after applying the | operator.

impl BitOrAssign<ContextFlags> for ContextFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<ContextFlags> for ContextFlags

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

Returns the left flags, but with all the right flags toggled.

type Output = ContextFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<ContextFlags> for ContextFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Extend<ContextFlags> for ContextFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<ContextFlags> for ContextFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl IntoIterator for ContextFlags

type Item = ContextFlags

The type of the elements being iterated over.

type IntoIter = Iter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for ContextFlags

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

Formats the value using the given formatter.

impl Not for ContextFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = ContextFlags

The resulting type after applying the ! operator.

impl Octal for ContextFlags

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

Formats the value using the given formatter.

impl PublicFlags for ContextFlags

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub<ContextFlags> for ContextFlags

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

Returns the set difference of the two sets of flags.

type Output = ContextFlags

The resulting type after applying the - operator.

impl SubAssign<ContextFlags> for ContextFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for ContextFlags

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

Formats the value using the given formatter.