1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
use crate::{
Result,
client::{PreparedCommand, PubSubStream, prepare_command},
resp::{FastPathCommandBuilder, Response, cmd},
};
use serde::Serialize;
/// A group of Redis commands related to [`Pub/Sub`](https://redis.io/docs/manual/pubsub/)
/// # See Also
/// [Redis Pub/Sub Commands](https://redis.io/commands/?group=pubsub)
pub trait PubSubCommands<'a>: Sized {
/// Subscribes the client to the given patterns.
///
/// # Example
/// ```
/// use rustis::{
/// client::{Client, ClientPreparedCommand},
/// commands::{FlushingMode, PubSubCommands, ServerCommands},
/// resp::cmd,
/// Result,
/// };
/// use futures_util::StreamExt;
///
/// #[cfg_attr(feature = "tokio-runtime", tokio::main)]
/// #[cfg_attr(feature = "async-std-runtime", async_std::main)]
/// async fn main() -> Result<()> {
/// let pub_sub_client = Client::connect("127.0.0.1:6379").await?;
/// let regular_client = Client::connect("127.0.0.1:6379").await?;
///
/// regular_client.flushdb(FlushingMode::Sync).await?;
///
/// let mut pub_sub_stream = pub_sub_client.psubscribe("mychannel*").await?;
///
/// regular_client.publish("mychannel1", "mymessage").await?;
///
/// let message = pub_sub_stream.next().await.unwrap()?;
/// assert_eq!(b"mychannel*".to_vec(), message.pattern);
/// assert_eq!(b"mychannel1".to_vec(), message.channel);
/// assert_eq!(b"mymessage".to_vec(), message.payload);
///
/// pub_sub_stream.close().await?;
///
/// Ok(())
/// }
/// ```
///
/// # See Also
/// [<https://redis.io/commands/psubscribe/>](https://redis.io/commands/psubscribe/)
#[allow(async_fn_in_trait)]
async fn psubscribe(self, patterns: impl Serialize) -> Result<PubSubStream>;
/// Posts a message to the given channel.
///
/// # Return
/// The number of clients that received the message.
///
/// Note that in a Redis Cluster, only clients that are connected
/// to the same node as the publishing client are included in the count.
///
/// # See Also
/// [<https://redis.io/commands/publish/>](https://redis.io/commands/publish/)
fn publish(
self,
channel: impl Serialize,
message: impl Serialize,
) -> PreparedCommand<'a, Self, usize> {
prepare_command(self, FastPathCommandBuilder::publish(channel, message))
}
/// Lists the currently active channels.
///
/// * `pattern` - A pattern to filter the results.
/// Pass `()` to list all active channels.
///
/// # Return
/// A collection of active channels, optionally matching the specified pattern.
///
/// # See Also
/// [<https://redis.io/commands/pubsub-channels/>](https://redis.io/commands/pubsub-channels/)
fn pub_sub_channels<R: Response>(
self,
pattern: impl Serialize,
) -> PreparedCommand<'a, Self, R> {
prepare_command(self, cmd("PUBSUB").arg("CHANNELS").arg(pattern))
}
/// The command returns a helpful text describing the different PUBSUB subcommands.
///
/// # Return
/// An array of strings.
///
/// # Example
/// ```
/// # use rustis::{
/// # client::Client,
/// # commands::PubSubCommands,
/// # Result,
/// # };
/// #
/// # #[cfg_attr(feature = "tokio-runtime", tokio::main)]
/// # #[cfg_attr(feature = "async-std-runtime", async_std::main)]
/// # async fn main() -> Result<()> {
/// # let client = Client::connect("127.0.0.1:6379").await?;
/// let result: Vec<String> = client.pub_sub_help().await?;
/// assert!(result.iter().any(|e| e == "HELP"));
/// # Ok(())
/// # }
/// ```
///
/// # See Also
/// [<https://redis.io/commands/pubsub-help/>](https://redis.io/commands/pubsub-help/)
#[must_use]
fn pub_sub_help(self) -> PreparedCommand<'a, Self, Vec<String>> {
prepare_command(self, cmd("PUBSUB").arg("HELP"))
}
/// Returns the number of unique patterns that are subscribed to by clients
/// (that are performed using the PSUBSCRIBE command).
///
/// # Return
/// The number of patterns all the clients are subscribed to.
///
/// # See Also
/// [<https://redis.io/commands/pubsub-numpat/>](https://redis.io/commands/pubsub-numpat/)
fn pub_sub_numpat(self) -> PreparedCommand<'a, Self, usize> {
prepare_command(self, cmd("PUBSUB").arg("NUMPAT"))
}
/// Returns the number of subscribers (exclusive of clients subscribed to patterns)
/// for the specified channels.
///
/// # Return
/// A collection of channels and number of subscribers for every channel.
///
/// # See Also
/// [<https://redis.io/commands/pubsub-numsub/>](https://redis.io/commands/pubsub-numsub/)
fn pub_sub_numsub<R: Response>(self, channels: impl Serialize) -> PreparedCommand<'a, Self, R> {
prepare_command(self, cmd("PUBSUB").arg("NUMSUB").arg(channels))
}
/// Lists the currently active shard channels.
///
/// * `pattern` - A pattern to filter the results.
/// Pass `()` to list all active channels.
///
/// # Return
/// A collection of active channels, optionally matching the specified pattern.
///
/// # See Also
/// [<https://redis.io/commands/pubsub-shardchannels/>](https://redis.io/commands/pubsub-shardchannels/)
fn pub_sub_shardchannels<R: Response>(
self,
pattern: impl Serialize,
) -> PreparedCommand<'a, Self, R> {
prepare_command(self, cmd("PUBSUB").arg("SHARDCHANNELS").arg(pattern))
}
/// Returns the number of subscribers for the specified shard channels.
///
/// # Return
/// A collection of channels and number of subscribers for every channel.
///
/// # See Also
/// [<https://redis.io/commands/pubsub-shardnumsub/>](https://redis.io/commands/pubsub-shardnumsub/)
fn pub_sub_shardnumsub<R: Response>(
self,
channels: impl Serialize,
) -> PreparedCommand<'a, Self, R> {
prepare_command(self, cmd("PUBSUB").arg("SHARDNUMSUB").arg(channels))
}
/// Posts a message to the given shard channel.
///
/// # Return
/// The number of clients that received the message.
///
/// # See Also
/// [<https://redis.io/commands/spublish/>](https://redis.io/commands/spublish/)
fn spublish(
self,
shardchannel: impl Serialize,
message: impl Serialize,
) -> PreparedCommand<'a, Self, usize> {
prepare_command(self, cmd("SPUBLISH").arg(shardchannel).arg(message))
}
/// Subscribes the client to the specified channels.
///
/// # See Also
/// [<https://redis.io/commands/subscribe/>](https://redis.io/commands/subscribe/)
#[allow(async_fn_in_trait)]
async fn ssubscribe(self, shardchannels: impl Serialize) -> Result<PubSubStream>;
/// Subscribes the client to the specified channels.
///
/// # Example
/// ```
/// use rustis::{
/// client::{Client, ClientPreparedCommand},
/// commands::{FlushingMode, PubSubCommands, ServerCommands},
/// resp::cmd,
/// Result,
/// };
/// use futures_util::StreamExt;
///
/// #[cfg_attr(feature = "tokio-runtime", tokio::main)]
/// #[cfg_attr(feature = "async-std-runtime", async_std::main)]
/// async fn main() -> Result<()> {
/// let pub_sub_client = Client::connect("127.0.0.1:6379").await?;
/// let regular_client = Client::connect("127.0.0.1:6379").await?;
///
/// regular_client.flushdb(FlushingMode::Sync).await?;
///
/// let mut pub_sub_stream = pub_sub_client.subscribe("mychannel").await?;
///
/// regular_client.publish("mychannel", "mymessage").await?;
///
/// let message = pub_sub_stream.next().await.unwrap()?;
/// assert_eq!(b"mychannel".to_vec(), message.channel);
/// assert_eq!(b"mymessage".to_vec(), message.payload);
///
/// pub_sub_stream.close().await?;
///
/// Ok(())
/// }
/// ```
///
/// # See Also
/// [<https://redis.io/commands/subscribe/>](https://redis.io/commands/subscribe/)
#[allow(async_fn_in_trait)]
async fn subscribe(self, channels: impl Serialize) -> Result<PubSubStream>;
}