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
use crate::{
prepare_command,
resp::{
cmd, CommandArg, FromSingleValueArray, FromValue, HashMapExt, KeyValueArgOrCollection,
SingleArgOrCollection, Value,
},
PreparedCommand, Result,
};
use std::collections::HashMap;
/// A group of Redis commands related to [`Count-min Sketch`](https://redis.io/docs/stack/bloom/)
///
/// # See Also
/// [Count-min Sketch Commands](https://redis.io/commands/?group=cms)
pub trait CountMinSketchCommands {
/// Increases the count of item by increment.
///
/// Multiple items can be increased with one call.
///
/// # Arguments
/// * `key` - The name of the sketch.
/// * `items` - A collection of tuples of
/// * `item` - The item which counter is to be increased.
/// * `increment`- Amount by which the item counter is to be increased.
///
/// # Return
/// A collection of count of each item after increment.
///
/// # See Also
/// * [<https://redis.io/commands/cms.incrby/>](https://redis.io/commands/cms.incrby/)
#[must_use]
fn cms_incrby<I: Into<CommandArg>, R: FromSingleValueArray<usize>>(
&mut self,
key: impl Into<CommandArg>,
items: impl KeyValueArgOrCollection<I, usize>,
) -> PreparedCommand<Self, R>
where
Self: Sized,
{
prepare_command(self, cmd("CMS.INCRBY").arg(key).arg(items))
}
/// Returns width, depth and total count of the sketch.
///
/// # Arguments
/// * `key` - The name of the sketch.
///
/// # See Also
/// * [<https://redis.io/commands/cms.info/>](https://redis.io/commands/cms.info/)
#[must_use]
fn cms_info(&mut self, key: impl Into<CommandArg>) -> PreparedCommand<Self, CmsInfoResult>
where
Self: Sized,
{
prepare_command(self, cmd("CMS.INFO").arg(key))
}
/// Initializes a Count-Min Sketch to dimensions specified by user.
///
/// Multiple items can be increased with one call.
///
/// # Arguments
/// * `key` - The name of the sketch.
/// * `width` - Number of counters in each array. Reduces the error size.
/// * `depth` - Number of counter-arrays. Reduces the probability for an error of a certain size (percentage of total count).
///
/// # See Also
/// * [<https://redis.io/commands/cms.initbydim/>](https://redis.io/commands/cms.initbydim/)
#[must_use]
fn cms_initbydim(
&mut self,
key: impl Into<CommandArg>,
width: usize,
depth: usize,
) -> PreparedCommand<Self, ()>
where
Self: Sized,
{
prepare_command(self, cmd("CMS.INITBYDIM").arg(key).arg(width).arg(depth))
}
/// Initializes a Count-Min Sketch to accommodate requested tolerances.
///
/// # Arguments
/// * `key` - The name of the sketch.
/// * `error` - Estimate size of error.\
/// The error is a percent of total counted items. This effects the width of the sketch.
/// * `probability` - The desired probability for inflated count. \
/// This should be a decimal value between 0 and 1.
/// This effects the depth of the sketch.
/// For example, for a desired false positive rate of 0.1% (1 in 1000),
/// error_rate should be set to 0.001. The closer this number is to zero,
/// the greater the memory consumption per item and the more CPU usage per operation.
///
/// # See Also
/// * [<https://redis.io/commands/cms.initbyprob/>](https://redis.io/commands/cms.initbyprob/)
#[must_use]
fn cms_initbyprob(
&mut self,
key: impl Into<CommandArg>,
error: f64,
probability: f64,
) -> PreparedCommand<Self, ()>
where
Self: Sized,
{
prepare_command(
self,
cmd("CMS.INITBYPROB").arg(key).arg(error).arg(probability),
)
}
/// Returns the count for one or more items in a sketch.
///
/// All sketches must have identical width and depth.
/// Weights can be used to multiply certain sketches.
/// Default weight is 1.
///
/// # Arguments
/// * `destination` - The name of destination sketch. Must be initialized.
/// * `sources` - Names of source sketches to be merged.
/// * `weights` - Multiple of each sketch. Default =1.
///
/// # See Also
/// * [<https://redis.io/commands/cms.merge/>](https://redis.io/commands/cms.merge/)
#[must_use]
fn cms_merge<S: Into<CommandArg>, W: SingleArgOrCollection<usize>>(
&mut self,
destination: impl Into<CommandArg>,
sources: impl SingleArgOrCollection<S>,
weights: Option<W>,
) -> PreparedCommand<Self, ()>
where
Self: Sized,
{
prepare_command(
self,
cmd("CMS.MERGE")
.arg(destination)
.arg(sources.num_args())
.arg(sources)
.arg(weights.map(|w| ("WEIGHTS", w))),
)
}
/// Merges several sketches into one sketch.
///
/// All sketches must have identical width and depth.
/// Weights can be used to multiply certain sketches.
/// Default weight is 1.
///
/// # Arguments
/// * `key` - The name of the sketch.
/// * `item` - One or more items for which to return the count.
///
/// # Return
/// Count of one or more items
///
/// # See Also
/// * [<https://redis.io/commands/cms.query/>](https://redis.io/commands/cms.query/)
#[must_use]
fn cms_query<I: Into<CommandArg>, C: FromSingleValueArray<usize>>(
&mut self,
key: impl Into<CommandArg>,
items: impl SingleArgOrCollection<I>,
) -> PreparedCommand<Self, C>
where
Self: Sized,
{
prepare_command(self, cmd("CMS.QUERY").arg(key).arg(items))
}
}
/// Result for the [`cms_info`](CountMinSketchCommands::cms_info) command.
#[derive(Debug)]
pub struct CmsInfoResult {
/// Width of the sketch
pub width: usize,
/// Depth of the sketch
pub depth: usize,
/// Total count of the sketch
pub total_count: usize,
}
impl FromValue for CmsInfoResult {
fn from_value(value: Value) -> Result<Self> {
let mut values: HashMap<String, Value> = value.into()?;
Ok(Self {
width: values.remove_or_default("width").into()?,
depth: values.remove_or_default("depth").into()?,
total_count: values.remove_or_default("count").into()?,
})
}
}