[][src]Crate redis_streams

redis-streams-rs exposes the Redis Stream functionality as a Trait on top of redis-rs.

The crate is called redis_streams.

In order to you use this crate, you'll first want to add it as a github dependency (until I have a chance to publish on crates.io).

[dependencies.redis_streams]
git = "https://github.com/grippy/redis-streams-rs.git"

From here, just unlock the streaming commands prior to instantiating client connections.

use redis_streams::{client_open,Connection,StreamCommands};
let client = client_open("redis://127.0.0.1/0").unwrap();
let mut con = client.get_connection().unwrap();

This crate also exposes all top-level redis-rs types. To pick up all redis-rs Commands, just use the Commands trait.

use redis_streams::{Commands};

Structs

StreamClaimOptions

Builder options for xclaim_options command.

StreamClaimReply

Reply type used with xclaim command.

StreamId

Represents a stream id and its field/values as a HashMap

StreamInfoConsumer

A consumer parsed from xinfo_consumers command.

StreamInfoConsumersReply

Reply type used with xinfo_consumer command.

StreamInfoGroup

A group parsed from xinfo_groups command.

StreamInfoGroupsReply

Reply type used with xinfo_groups command.

StreamInfoStreamReply

Reply type used with xinfo_stream command.

StreamKey

Represents a stream key and its id's parsed from xread methods.

StreamPendingCountReply

Reply type used with xpending_count and xpending_consumer_count commands.

StreamPendingData

Inner reply type when an [xpending] command has data.

StreamPendingId

Represents a pending message parsed from xpending methods.

StreamRangeReply

Reply type used with xrange, xrange_count, xrange_all, xrevrange, xrevrange_count, xrevrange_all commands.

StreamReadOptions

Builder options for xread_options command.

StreamReadReply

Reply type used with xread or xread_options commands.

Enums

StreamMaxlen

Utility enum for passing MAXLEN [= or ~] [COUNT] arguments into StreamCommands. The enum value represents the count.

StreamPendingReply

Reply type used with xpending command.

Traits

StreamCommands

Implementation of all redis stream commands.

Functions

client_open

Curry redis::Client::open calls.