Enum pliantdb_core::kv::Command

pub enum Command {
    Set {
        value: Value,
        expiration: Option<Timestamp>,
        keep_existing_expiration: bool,
        check: Option<KeyCheck>,
        return_previous_value: bool,
    },
    Get {
        delete: bool,
    },
    Increment {
        amount: Numeric,
        saturating: bool,
    },
    Decrement {
        amount: Numeric,
        saturating: bool,
    },
    Delete,
}

Commands for a key-value store.

Variants

Set

Set a key/value pair.

Fields of Set

value: Value

The value.

expiration: Option<Timestamp>

If set, the key will be set to expire automatically.

keep_existing_expiration: bool

If true and the key already exists, the expiration will not be updated. If false and an expiration is provided, the expiration will be set.

check: Option<KeyCheck>

Conditional checks for whether the key is already present or not.

return_previous_value: bool

If true and the key already exists, the existing key will be returned if overwritten.

Get

Get the value from a key.

Fields of Get

delete: bool

Remove the key after retrieving the value.

Increment

Increment a numeric key. Returns an error if the key cannot be deserialized to the same numeric type as amount. If saturating is true, overflows will be prevented and the value will remain within the numeric bounds.

Fields of Increment

amount: Numeric

The amount to increment by.

saturating: bool

If true, the result will be constrained to the numerical bounds of the type of amount.

Decrement

Decrement a numeric key. Returns an error if the key cannot be deserialized to the same numeric type as amount. If saturating is true, overflows will be prevented and the value will remain within the numeric bounds.

Fields of Decrement

amount: Numeric

The amount to increment by.

saturating: bool

If true, the result will be constrained to the numerical bounds of the type of amount.

Delete

Delete a key.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Command

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.