Connection

Struct Connection 

Source
pub struct Connection { /* private fields */ }
Expand description

An open connection to a Redis server.

§Examples

Get a value from the Redis database.

use spin_sdk::redis::Connection;

let conn = Connection::open("redis://127.0.0.1:6379")?;
let payload = conn.get("archimedes-data")?;
if let Some(data) = payload {
    println!("{}", String::from_utf8_lossy(&data));
}

Set a value in the Redis database.

use spin_sdk::redis::Connection;

let conn = Connection::open("redis://127.0.0.1:6379")?;
let payload = "Eureka!".to_owned().into_bytes();
conn.set("archimedes-data", &payload)?;

Delete a value from the Redis database.

use spin_sdk::redis::Connection;

let conn = Connection::open("redis://127.0.0.1:6379")?;
conn.del(&["archimedes-data".to_owned()])?;

Publish a message to a Redis channel.

use spin_sdk::redis::Connection;

let conn = Connection::open("redis://127.0.0.1:6379")?;

let payload = request.body().to_vec();
ensure_pet_picture(&payload)?;

conn.publish("pet-pictures", &payload)?;

Implementations§

Source§

impl Connection

Source

pub fn open(address: &str) -> Result<Connection, Error>

Open a connection to the Redis instance at address.

Source§

impl Connection

Source

pub fn publish(&self, channel: &str, payload: &[u8]) -> Result<(), Error>

Publish a Redis message to the specified channel.

Source§

impl Connection

Source

pub fn get(&self, key: &str) -> Result<Option<Payload>, Error>

Get the value of a key.

Source§

impl Connection

Source

pub fn set(&self, key: &str, value: &[u8]) -> Result<(), Error>

Set key to value.

If key already holds a value, it is overwritten.

Source§

impl Connection

Source

pub fn incr(&self, key: &str) -> Result<i64, Error>

Increments the number stored at key by one.

If the key does not exist, it is set to 0 before performing the operation. An error::type-error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer.

Source§

impl Connection

Source

pub fn del(&self, keys: &[String]) -> Result<u32, Error>

Removes the specified keys.

A key is ignored if it does not exist. Returns the number of keys deleted.

Source§

impl Connection

Source

pub fn sadd(&self, key: &str, values: &[String]) -> Result<u32, Error>

Add the specified values to the set named key, returning the number of newly-added values.

Source§

impl Connection

Source

pub fn smembers(&self, key: &str) -> Result<Vec<String>, Error>

Retrieve the contents of the set named key.

Source§

impl Connection

Source

pub fn srem(&self, key: &str, values: &[String]) -> Result<u32, Error>

Remove the specified values from the set named key, returning the number of newly-removed values.

Source§

impl Connection

Source

pub fn execute( &self, command: &str, arguments: &[RedisParameter], ) -> Result<Vec<RedisResult>, Error>

Execute an arbitrary Redis command and receive the result.

Trait Implementations§

Source§

impl Debug for Connection

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V