Struct red::State

pub struct State { /* fields omitted */ }

An opaque type that stores data.

This is used by both red and red-server independently, kind of like a singleton instance; however, you can make as many instances as you need.

Methods

impl State

Implements functionality for Store. At time of writing this documentation, it supports a few "commands" in a similar way to Redis: I've only implemented the ones I actually need.

Full 1:1 mapping of Redis commands is not a goal, but it would be nice to keep following their spec closely.

pub fn new() -> Self

Instantiate State by calling this function.

Example

use red::State;

let mut state = State::new();

pub fn get(&mut self, key: &str) -> Option<&String>

Get the value of key.

Example

// The return value of the function is an option
let value = state.get("someKey");

// Pattern match to retrieve the value
match value {
    // The key was present
    Some(v) => println!("Value: {}", v),
    // The key was not present
    None    => println!("Nope"),
}

pub fn sadd(&mut self, member: String) -> bool

Add a new member to the set. If the member is already in the set, it will be ignored.

Example

state.sadd("BOOMBAYAH".to_string());

assert_eq!("BOOMBAYAH", state.smembers().next().unwrap());

pub fn smembers(&mut self) -> impl Iterator<Item = &String>

Returns an iterator to retrieve some or all the members of the set. The retrieval order is completely arbitrary.

Example

state.sadd("foo".to_string());
state.sadd("bar".to_string());

// Will print in an arbitrary order.
for member in state.smembers() {
    println!("{}", member);
}

For more detail about iterators, see the official docs.

pub fn srem(&mut self, member: &str) -> bool

Remove the specified member from the set.

Returns true if the member was in the set; false otherwise.

Example

state.sadd("mittsies".to_string());

assert_eq!(state.srem("mittsies"), true);
assert_eq!(state.srem("mittsies"), false);

pub fn set(&mut self, key: String, value: String)

Set key to hold the specified value. If the key already holds a value, it is overwritten.

Example

state.set("someKey".to_string(), "Blade".to_string());

assert_eq!(state.get("someKey").unwrap(), "Blade");

Trait Implementations

impl Debug for State

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

Formats the value using the given formatter.