Skip to main content

SetOptions

Struct SetOptions 

Source
pub struct SetOptions<'a> {
    pub exists: Exists,
    pub expire: Expire,
    pub compare: Option<Compare<'a>>,
    pub get: bool,
}
Expand description

Everything SET can be asked to do beyond storing the value.

Fields§

§exists: Exists

NX or XX.

§expire: Expire

EX, PX, EXAT, PXAT or KEEPTTL.

§compare: Option<Compare<'a>>

IFEQ, IFNE, IFDEQ or IFDNE.

Redis 8.4’s compare and set. A missing key never compares equal, so IFEQ on a key that is not there does not store, and IFNE on one does.

§get: bool

GET: hand back what was there, whether or not the write happened.

Implementations§

Source§

impl<'a> SetOptions<'a>

Source

pub const PLAIN: SetOptions<'static>

No options at all, which is plain SET.

Source

pub const fn if_missing(self) -> SetOptions<'a>

This, but only if the key is missing.

Source

pub const fn if_present(self) -> SetOptions<'a>

This, but only if the key is present.

Source

pub const fn expiring(self, e: Expire) -> SetOptions<'a>

This, with a deadline.

Source

pub const fn if_equal(self, bytes: &'a [u8]) -> SetOptions<'a>

This, but only if the current value is exactly bytes. IFEQ.

Source

pub const fn if_not_equal(self, bytes: &'a [u8]) -> SetOptions<'a>

This, but only if the current value is not exactly bytes. IFNE.

Source

pub const fn if_digest(self, d: u64) -> SetOptions<'a>

This, but only against a value whose digest is d. IFDEQ.

Source

pub const fn if_not_digest(self, d: u64) -> SetOptions<'a>

This, but only against a value whose digest is not d. IFDNE.

Source

pub const fn returning(self) -> SetOptions<'a>

This, returning the previous value.

Trait Implementations§

Source§

impl<'a> Clone for SetOptions<'a>

Source§

fn clone(&self) -> SetOptions<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for SetOptions<'a>

Source§

impl<'a> Debug for SetOptions<'a>

Source§

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

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

impl<'a> Default for SetOptions<'a>

Source§

fn default() -> SetOptions<'a>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for SetOptions<'a>

§

impl<'a> RefUnwindSafe for SetOptions<'a>

§

impl<'a> Send for SetOptions<'a>

§

impl<'a> Sync for SetOptions<'a>

§

impl<'a> Unpin for SetOptions<'a>

§

impl<'a> UnsafeUnpin for SetOptions<'a>

§

impl<'a> UnwindSafe for SetOptions<'a>

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

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.