Enum Command 

pub enum Command {
    Ping(Option<Bytes>),
    Echo(Bytes),
    Get {
        key: String,
    },
    Set {
        key: String,
        value: Bytes,
        expire: Option<SetExpire>,
        nx: bool,
        xx: bool,
    },
    Incr {
        key: String,
    },
    Decr {
        key: String,
    },
    Del {
        keys: Vec<String>,
    },
    Exists {
        keys: Vec<String>,
    },
    MGet {
        keys: Vec<String>,
    },
    MSet {
        pairs: Vec<(String, Bytes)>,
    },
    Expire {
        key: String,
        seconds: u64,
    },
    Ttl {
        key: String,
    },
    Persist {
        key: String,
    },
    Pttl {
        key: String,
    },
    Pexpire {
        key: String,
        milliseconds: u64,
    },
    DbSize,
    Info {
        section: Option<String>,
    },
    BgSave,
    BgRewriteAof,
    FlushDb,
    Scan {
        cursor: u64,
        pattern: Option<String>,
        count: Option<usize>,
    },
    LPush {
        key: String,
        values: Vec<Bytes>,
    },
    RPush {
        key: String,
        values: Vec<Bytes>,
    },
    LPop {
        key: String,
    },
    RPop {
        key: String,
    },
    LRange {
        key: String,
        start: i64,
        stop: i64,
    },
    LLen {
        key: String,
    },
    Type {
        key: String,
    },
    ZAdd {
        key: String,
        flags: ZAddFlags,
        members: Vec<(f64, String)>,
    },
    ZRem {
        key: String,
        members: Vec<String>,
    },
    ZScore {
        key: String,
        member: String,
    },
    ZRank {
        key: String,
        member: String,
    },
    ZCard {
        key: String,
    },
    ZRange {
        key: String,
        start: i64,
        stop: i64,
        with_scores: bool,
    },
    HSet {
        key: String,
        fields: Vec<(String, Bytes)>,
    },
    HGet {
        key: String,
        field: String,
    },
    HGetAll {
        key: String,
    },
    HDel {
        key: String,
        fields: Vec<String>,
    },
    HExists {
        key: String,
        field: String,
    },
    HLen {
        key: String,
    },
    HIncrBy {
        key: String,
        field: String,
        delta: i64,
    },
    HKeys {
        key: String,
    },
    HVals {
        key: String,
    },
    HMGet {
        key: String,
        fields: Vec<String>,
    },
    SAdd {
        key: String,
        members: Vec<String>,
    },
    SRem {
        key: String,
        members: Vec<String>,
    },
    SMembers {
        key: String,
    },
    SIsMember {
        key: String,
        member: String,
    },
    SCard {
        key: String,
    },
    Unknown(String),
}

A parsed client command, ready for execution.

Variants

Ping(Option<Bytes>)

PING with an optional message. Returns PONG or echoes the message.

Echo(Bytes)

ECHO . Returns the message back to the client.

Get

GET . Returns the value or nil.

Fields

key: String

Set

SET [EX seconds | PX milliseconds] [NX | XX].

Fields

key: String

value: Bytes

expire: Option<SetExpire>

nx: bool

Only set the key if it does not already exist.

xx: bool

Only set the key if it already exists.

Incr

INCR . Increments the integer value of a key by 1.

Fields

key: String

Decr

DECR . Decrements the integer value of a key by 1.

Fields

key: String

Del

DEL [key …]. Returns the number of keys removed.

Fields

keys: Vec<String>

Exists

EXISTS [key …]. Returns the number of keys that exist.

Fields

keys: Vec<String>

MGet

MGET [key …]. Returns the values for all specified keys.

Fields

keys: Vec<String>

MSet

MSET [key value …]. Sets multiple key-value pairs.

Fields

pairs: Vec<(String, Bytes)>

Expire

EXPIRE . Sets a TTL on an existing key.

Fields

key: String

seconds: u64

Ttl

TTL . Returns remaining time-to-live in seconds.

Fields

key: String

Persist

PERSIST . Removes the expiration from a key.

Fields

key: String

Pttl

PTTL . Returns remaining time-to-live in milliseconds.

Fields

key: String

Pexpire

PEXPIRE . Sets a TTL in milliseconds on an existing key.

Fields

key: String

milliseconds: u64

DbSize

DBSIZE. Returns the number of keys in the database.

Info

INFO [section]. Returns server info. Currently only supports “keyspace”.

Fields

section: Option<String>

BgSave

BGSAVE. Triggers a background snapshot.

BgRewriteAof

BGREWRITEAOF. Triggers an AOF rewrite (snapshot + truncate).

FlushDb

FLUSHDB. Removes all keys from the database.

Scan

SCAN [MATCH pattern] [COUNT count]. Iterates keys.

Fields

cursor: u64

pattern: Option<String>

count: Option<usize>

LPush

LPUSH [value …]. Pushes values to the head of a list.

Fields

key: String

values: Vec<Bytes>

RPush

RPUSH [value …]. Pushes values to the tail of a list.

Fields

key: String

values: Vec<Bytes>

LPop

LPOP . Pops a value from the head of a list.

Fields

key: String

RPop

RPOP . Pops a value from the tail of a list.

Fields

key: String

LRange

LRANGE . Returns a range of elements by index.

Fields

key: String

start: i64

stop: i64

LLen

LLEN . Returns the length of a list.

Fields

key: String

Type

TYPE . Returns the type of the value stored at key.

Fields

key: String

ZAdd

ZADD [NX|XX] [GT|LT] [CH] [score member …].

Fields

key: String

flags: ZAddFlags

members: Vec<(f64, String)>

ZRem

ZREM [member …]. Removes members from a sorted set.

Fields

key: String

members: Vec<String>

ZScore

ZSCORE . Returns the score of a member.

Fields

key: String

member: String

ZRank

ZRANK . Returns the rank of a member (0-based).

Fields

key: String

member: String

ZCard

ZCARD . Returns the cardinality (number of members) of a sorted set.

Fields

key: String

ZRange

ZRANGE [WITHSCORES]. Returns a range by rank.

Fields

key: String

start: i64

stop: i64

with_scores: bool

HSet

HSET [field value …]. Sets field-value pairs in a hash.

Fields

key: String

fields: Vec<(String, Bytes)>

HGet

HGET . Gets a field’s value from a hash.

Fields

key: String

field: String

HGetAll

HGETALL . Gets all field-value pairs from a hash.

Fields

key: String

HDel

HDEL [field …]. Deletes fields from a hash.

Fields

key: String

fields: Vec<String>

HExists

HEXISTS . Checks if a field exists in a hash.

Fields

key: String

field: String

HLen

HLEN . Returns the number of fields in a hash.

Fields

key: String

HIncrBy

HINCRBY . Increments a hash field’s integer value.

Fields

key: String

field: String

delta: i64

HKeys

HKEYS . Returns all field names in a hash.

Fields

key: String

HVals

HVALS . Returns all values in a hash.

Fields

key: String

HMGet

HMGET [field …]. Gets multiple field values from a hash.

Fields

key: String

fields: Vec<String>

SAdd

SADD [member …]. Adds members to a set.

Fields

key: String

members: Vec<String>

SRem

SREM [member …]. Removes members from a set.

Fields

key: String

members: Vec<String>

SMembers

SMEMBERS . Returns all members of a set.

Fields

key: String

SIsMember

SISMEMBER . Checks if a member exists in a set.

Fields

key: String

member: String

SCard

SCARD . Returns the cardinality (number of members) of a set.

Fields

key: String

Unknown(String)

A command we don’t recognize (yet).

Implementations

impl Command

pub fn from_frame(frame: Frame) -> Result<Command, ProtocolError>

Parses a Frame into a Command.

Expects an array frame where the first element is the command name (as a bulk or simple string) and the rest are arguments.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate 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 PartialEq for Command

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Command