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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
use crate::{
commands,
interfaces::{ClientLike, RedisResult},
prelude::RedisError,
types::{
FromRedis,
FromRedisKey,
MultipleIDs,
MultipleKeys,
MultipleOrderedPairs,
MultipleStrings,
RedisKey,
RedisValue,
XCap,
XPendingArgs,
XReadResponse,
XReadValue,
XID,
},
};
use bytes_utils::Str;
use fred_macros::rm_send_if;
use futures::Future;
use std::{convert::TryInto, hash::Hash};
/// Functions that implement the [streams](https://redis.io/commands#stream) interface.
///
/// **Note:** Several of the stream commands can return types with verbose type declarations. Additionally, certain
/// commands can be parsed differently in RESP2 and RESP3 modes. Functions such as [xread_map](Self::xread_map),
/// [xreadgroup_map](Self::xreadgroup_map), [xrange_values](Self::xrange_values), etc exist to make this easier for
/// callers. These functions apply an additional layer of parsing logic that can make declaring response types easier,
/// as well as automatically handling any differences between RESP2 and RESP3 return value types.
#[rm_send_if(feature = "glommio")]
pub trait StreamsInterface: ClientLike + Sized {
/// This command returns the list of consumers that belong to the `groupname` consumer group of the stream stored at
/// `key`.
///
/// <https://redis.io/commands/xinfo-consumers>
fn xinfo_consumers<R, K, S>(&self, key: K, groupname: S) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
S: Into<Str> + Send,
{
async move {
into!(key, groupname);
commands::streams::xinfo_consumers(self, key, groupname)
.await?
.convert()
}
}
/// This command returns the list of all consumers groups of the stream stored at `key`.
///
/// <https://redis.io/commands/xinfo-groups>
fn xinfo_groups<R, K>(&self, key: K) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
{
async move {
into!(key);
commands::streams::xinfo_groups(self, key).await?.convert()
}
}
/// This command returns information about the stream stored at `key`.
///
/// <https://redis.io/commands/xinfo-stream>
fn xinfo_stream<R, K>(&self, key: K, full: bool, count: Option<u64>) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
{
async move {
into!(key);
commands::streams::xinfo_stream(self, key, full, count).await?.convert()
}
}
/// Appends the specified stream entry to the stream at the specified key. If the key does not exist, as a side
/// effect of running this command the key is created with a stream value. The creation of stream's key can be
/// disabled with the NOMKSTREAM option.
///
/// <https://redis.io/commands/xadd>
fn xadd<R, K, C, I, F>(
&self,
key: K,
nomkstream: bool,
cap: C,
id: I,
fields: F,
) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
I: Into<XID> + Send,
F: TryInto<MultipleOrderedPairs> + Send,
F::Error: Into<RedisError> + Send,
C: TryInto<XCap> + Send,
C::Error: Into<RedisError> + Send,
{
async move {
into!(key, id);
try_into!(fields, cap);
commands::streams::xadd(self, key, nomkstream, cap, id, fields)
.await?
.convert()
}
}
/// Trims the stream by evicting older entries (entries with lower IDs) if needed.
///
/// <https://redis.io/commands/xtrim>
fn xtrim<R, K, C>(&self, key: K, cap: C) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
C: TryInto<XCap> + Send,
C::Error: Into<RedisError> + Send,
{
async move {
into!(key);
try_into!(cap);
commands::streams::xtrim(self, key, cap).await?.convert()
}
}
/// Removes the specified entries from a stream, and returns the number of entries deleted.
///
/// <https://redis.io/commands/xdel>
fn xdel<R, K, S>(&self, key: K, ids: S) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
S: Into<MultipleStrings> + Send,
{
async move {
into!(key, ids);
commands::streams::xdel(self, key, ids).await?.convert()
}
}
/// Return the stream entries matching the provided range of IDs, automatically converting to a less verbose type
/// definition.
///
/// <https://redis.io/commands/xrange>
fn xrange_values<Ri, Rk, Rv, K, S, E>(
&self,
key: K,
start: S,
end: E,
count: Option<u64>,
) -> impl Future<Output = RedisResult<Vec<XReadValue<Ri, Rk, Rv>>>> + Send
where
Ri: FromRedis,
Rk: FromRedisKey + Hash + Eq,
Rv: FromRedis,
K: Into<RedisKey> + Send,
S: TryInto<RedisValue> + Send,
S::Error: Into<RedisError> + Send,
E: TryInto<RedisValue> + Send,
E::Error: Into<RedisError> + Send,
{
async move {
into!(key);
try_into!(start, end);
commands::streams::xrange(self, key, start, end, count)
.await?
.into_xread_value()
}
}
/// The command returns the stream entries matching a given range of IDs. The range is specified by a minimum
/// and maximum ID. All the entries having an ID between the two specified or exactly one of the two IDs specified
/// (closed interval) are returned.
///
/// <https://redis.io/commands/xrange>
///
/// **See [xrange_values](Self::xrange_values) for a variation of this function that may be more useful.**
fn xrange<R, K, S, E>(
&self,
key: K,
start: S,
end: E,
count: Option<u64>,
) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
S: TryInto<RedisValue> + Send,
S::Error: Into<RedisError> + Send,
E: TryInto<RedisValue> + Send,
E::Error: Into<RedisError> + Send,
{
async move {
into!(key);
try_into!(start, end);
commands::streams::xrange(self, key, start, end, count).await?.convert()
}
}
/// Similar to `XRANGE`, but with the results returned in reverse order. The results will be automatically converted
/// to a less verbose type definition.
///
/// <https://redis.io/commands/xrevrange>
fn xrevrange_values<Ri, Rk, Rv, K, E, S>(
&self,
key: K,
end: E,
start: S,
count: Option<u64>,
) -> impl Future<Output = RedisResult<Vec<XReadValue<Ri, Rk, Rv>>>> + Send
where
Ri: FromRedis,
Rk: FromRedisKey + Hash + Eq,
Rv: FromRedis,
K: Into<RedisKey> + Send,
S: TryInto<RedisValue> + Send,
S::Error: Into<RedisError> + Send,
E: TryInto<RedisValue> + Send,
E::Error: Into<RedisError> + Send,
{
async move {
into!(key);
try_into!(start, end);
commands::streams::xrevrange(self, key, end, start, count)
.await?
.into_xread_value()
}
}
/// Similar to `XRANGE`, but with the results returned in reverse order.
///
/// <https://redis.io/commands/xrevrange>
///
/// **See the [xrevrange_values](Self::xrevrange_values) for a variation of this function that may be more useful.**
fn xrevrange<R, K, S, E>(
&self,
key: K,
end: E,
start: S,
count: Option<u64>,
) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
S: TryInto<RedisValue> + Send,
S::Error: Into<RedisError> + Send,
E: TryInto<RedisValue> + Send,
E::Error: Into<RedisError> + Send,
{
async move {
into!(key);
try_into!(start, end);
commands::streams::xrevrange(self, key, end, start, count)
.await?
.convert()
}
}
/// Returns the number of entries inside a stream.
///
/// <https://redis.io/commands/xlen>
fn xlen<R, K>(&self, key: K) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
{
async move {
into!(key);
commands::streams::xlen(self, key).await?.convert()
}
}
/// Read data from one or multiple streams, only returning entries with an ID greater than the last received ID
/// reported by the caller.
///
/// <https://redis.io/commands/xread>
///
/// The `XREAD` and `XREADGROUP` commands return values that can be interpreted differently in RESP2 and RESP3 mode.
/// In many cases it is also easier to operate on the return values of these functions as a `HashMap`, but
/// manually declaring this type can be very verbose. This function will automatically convert the response to the
/// [most common](crate::types::XReadResponse) map representation while also handling the encoding differences
/// between RESP2 and RESP3.
///
/// ```rust no_run
/// # use fred::{prelude::*, types::XReadResponse};
/// async fn example(client: RedisClient) -> Result<(), RedisError> {
/// // borrowed from the tests. XREAD and XREADGROUP are very similar.
/// let result: XReadResponse<String, String, String, usize> = client
/// .xreadgroup_map("group1", "consumer1", None, None, false, "foo", ">")
/// .await?;
/// println!("Result: {:?}", result);
/// // Result: {"foo": [("1646240801081-0", {"count": 0}), ("1646240801082-0", {"count": 1}), ("1646240801082-1", {"count": 2})]}
///
/// assert_eq!(result.len(), 1);
/// for (idx, (id, record)) in result.get("foo").unwrap().into_iter().enumerate() {
/// let value = record.get("count").expect("Failed to read count");
/// assert_eq!(idx, *value);
/// }
///
/// Ok(())
/// }
/// ```
// The underlying issue here isn't so much a semantic difference between RESP2 and RESP3, but rather an assumption
// that went into the logic behind the `FromRedis` trait.
//
// In all other Redis commands that return "maps" in RESP2 (or responses that should be interpreted as maps) a map
// is encoded as an array with an even number of elements representing `(key, value)` pairs.
//
// As a result the `FromRedis` implementation for `HashMap`, `BTreeMap`, etc, took a dependency on this behavior. For example: https://redis.io/commands/hgetall#return-value
//
// ```
// 127.0.0.1:6379> hset foo bar 0
// (integer) 1
// 127.0.0.1:6379> hset foo baz 1
// (integer) 1
// 127.0.0.1:6379> hgetall foo
// 1) "bar"
// 2) "0"
// 3) "baz"
// 4) "1"
// // now switch to RESP3 which has a specific type for maps on the wire
// 127.0.0.1:6379> hello 3
// ...
// 127.0.0.1:6379> hgetall foo
// 1# "bar" => "0"
// 2# "baz" => "1"
// ```
//
// However, with XREAD/XREADGROUP there's an extra array wrapper in RESP2 around both the "outer" map and "inner"
// map(s):
//
// ```
// // RESP3
// 127.0.0.1:6379> xread count 2 streams foo bar 1643479648480-0 1643479834990-0
// 1# "foo" => 1) 1) "1643479650336-0"
// 2) 1) "count"
// 2) "3"
// 2# "bar" => 1) 1) "1643479837746-0"
// 2) 1) "count"
// 2) "5"
// 2) 1) "1643479925582-0"
// 2) 1) "count"
// 2) "6"
//
// // RESP2
// 127.0.0.1:6379> xread count 2 streams foo bar 1643479648480-0 1643479834990-0
// 1) 1) "foo"
// 2) 1) 1) "1643479650336-0"
// 2) 1) "count"
// 2) "3"
// 2) 1) "bar"
// 2) 1) 1) "1643479837746-0"
// 2) 1) "count"
// 2) "5"
// 2) 1) "1643479925582-0"
// 2) 1) "count"
// 2) "6"
// ```
//
// The underlying functions that do the RESP2 vs RESP3 conversion are public for callers as well, so one could use a
// `BTreeMap` instead of a `HashMap` like so:
//
// ```
// let value: BTreeMap<String, Vec<(String, BTreeMap<String, usize>)>> = client
// .xread::<RedisValue, _, _>(None, None, "foo", "0")
// .await?
// .flatten_array_values(2)
// .convert()?;
// ```
fn xread_map<Rk1, Rk2, Rk3, Rv, K, I>(
&self,
count: Option<u64>,
block: Option<u64>,
keys: K,
ids: I,
) -> impl Future<Output = RedisResult<XReadResponse<Rk1, Rk2, Rk3, Rv>>> + Send
where
Rk1: FromRedisKey + Hash + Eq,
Rk2: FromRedis,
Rk3: FromRedisKey + Hash + Eq,
Rv: FromRedis,
K: Into<MultipleKeys> + Send,
I: Into<MultipleIDs> + Send,
{
async move {
into!(keys, ids);
commands::streams::xread(self, count, block, keys, ids)
.await?
.into_xread_response()
}
}
/// Read data from one or multiple streams, only returning entries with an ID greater than the last received ID
/// reported by the caller.
///
/// <https://redis.io/commands/xread>
///
/// **See [xread_map](Self::xread_map) for more information on a variation of this function that might be more
/// useful.**
fn xread<R, K, I>(
&self,
count: Option<u64>,
block: Option<u64>,
keys: K,
ids: I,
) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<MultipleKeys> + Send,
I: Into<MultipleIDs> + Send,
{
async move {
into!(keys, ids);
commands::streams::xread(self, count, block, keys, ids).await?.convert()
}
}
/// This command creates a new consumer group uniquely identified by `groupname` for the stream stored at `key`.
///
/// <https://redis.io/commands/xgroup-create>
fn xgroup_create<R, K, S, I>(
&self,
key: K,
groupname: S,
id: I,
mkstream: bool,
) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
S: Into<Str> + Send,
I: Into<XID> + Send,
{
async move {
into!(key, groupname, id);
commands::streams::xgroup_create(self, key, groupname, id, mkstream)
.await?
.convert()
}
}
/// Create a consumer named `consumername` in the consumer group `groupname` of the stream that's stored at `key`.
///
/// <https://redis.io/commands/xgroup-createconsumer>
fn xgroup_createconsumer<R, K, G, C>(
&self,
key: K,
groupname: G,
consumername: C,
) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
G: Into<Str> + Send,
C: Into<Str> + Send,
{
async move {
into!(key, groupname, consumername);
commands::streams::xgroup_createconsumer(self, key, groupname, consumername)
.await?
.convert()
}
}
/// Delete a consumer named `consumername` in the consumer group `groupname` of the stream that's stored at `key`.
///
/// <https://redis.io/commands/xgroup-delconsumer>
fn xgroup_delconsumer<R, K, G, C>(
&self,
key: K,
groupname: G,
consumername: C,
) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
G: Into<Str> + Send,
C: Into<Str> + Send,
{
async move {
into!(key, groupname, consumername);
commands::streams::xgroup_delconsumer(self, key, groupname, consumername)
.await?
.convert()
}
}
/// Completely destroy a consumer group.
///
/// <https://redis.io/commands/xgroup-destroy>
fn xgroup_destroy<R, K, S>(&self, key: K, groupname: S) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
S: Into<Str> + Send,
{
async move {
into!(key, groupname);
commands::streams::xgroup_destroy(self, key, groupname).await?.convert()
}
}
/// Set the last delivered ID for a consumer group.
///
/// <https://redis.io/commands/xgroup-setid>
fn xgroup_setid<R, K, S, I>(&self, key: K, groupname: S, id: I) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
S: Into<Str> + Send,
I: Into<XID> + Send,
{
async move {
into!(key, groupname, id);
commands::streams::xgroup_setid(self, key, groupname, id)
.await?
.convert()
}
}
/// A special version of the `XREAD` command with support for consumer groups.
///
/// Declaring proper type declarations for this command can be complicated due to the complex nature of the response
/// values and the differences between RESP2 and RESP3. See the [xread](Self::xread) documentation for more
/// information.
///
/// <https://redis.io/commands/xreadgroup>
///
/// The `XREAD` and `XREADGROUP` commands return values that can be interpreted differently in RESP2 and RESP3 mode.
/// In many cases it is also easier to operate on the return values of these functions as a `HashMap`, but
/// manually declaring this type can be very verbose. This function will automatically convert the response to the
/// [most common](crate::types::XReadResponse) map representation while also handling the encoding differences
/// between RESP2 and RESP3.
///
/// See the [xread_map](Self::xread_map) documentation for more information.
// See the `xread_map` source docs for more information.
fn xreadgroup_map<Rk1, Rk2, Rk3, Rv, G, C, K, I>(
&self,
group: G,
consumer: C,
count: Option<u64>,
block: Option<u64>,
noack: bool,
keys: K,
ids: I,
) -> impl Future<Output = RedisResult<XReadResponse<Rk1, Rk2, Rk3, Rv>>> + Send
where
Rk1: FromRedisKey + Hash + Eq,
Rk2: FromRedis,
Rk3: FromRedisKey + Hash + Eq,
Rv: FromRedis,
G: Into<Str> + Send,
C: Into<Str> + Send,
K: Into<MultipleKeys> + Send,
I: Into<MultipleIDs> + Send,
{
async move {
into!(group, consumer, keys, ids);
commands::streams::xreadgroup(self, group, consumer, count, block, noack, keys, ids)
.await?
.into_xread_response()
}
}
/// A special version of the `XREAD` command with support for consumer groups.
///
/// Declaring proper type declarations for this command can be complicated due to the complex nature of the response
/// values and the differences between RESP2 and RESP3. See the [xread](Self::xread) documentation for more
/// information.
///
/// <https://redis.io/commands/xreadgroup>
///
/// **See [xreadgroup_map](Self::xreadgroup_map) for a variation of this function that might be more useful.**
fn xreadgroup<R, G, C, K, I>(
&self,
group: G,
consumer: C,
count: Option<u64>,
block: Option<u64>,
noack: bool,
keys: K,
ids: I,
) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
G: Into<Str> + Send,
C: Into<Str> + Send,
K: Into<MultipleKeys> + Send,
I: Into<MultipleIDs> + Send,
{
async move {
into!(group, consumer, keys, ids);
commands::streams::xreadgroup(self, group, consumer, count, block, noack, keys, ids)
.await?
.convert()
}
}
/// Remove one or more messages from the Pending Entries List (PEL) of a stream consumer group.
///
/// <https://redis.io/commands/xack>
fn xack<R, K, G, I>(&self, key: K, group: G, ids: I) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
G: Into<Str> + Send,
I: Into<MultipleIDs> + Send,
{
async move {
into!(key, group, ids);
commands::streams::xack(self, key, group, ids).await?.convert()
}
}
/// A variation of [xclaim](Self::xclaim) with a less verbose return type.
fn xclaim_values<Ri, Rk, Rv, K, G, C, I>(
&self,
key: K,
group: G,
consumer: C,
min_idle_time: u64,
ids: I,
idle: Option<u64>,
time: Option<u64>,
retry_count: Option<u64>,
force: bool,
justid: bool,
) -> impl Future<Output = RedisResult<Vec<XReadValue<Ri, Rk, Rv>>>> + Send
where
Ri: FromRedis,
Rk: FromRedisKey + Hash + Eq,
Rv: FromRedis,
K: Into<RedisKey> + Send,
G: Into<Str> + Send,
C: Into<Str> + Send,
I: Into<MultipleIDs> + Send,
{
async move {
into!(key, group, consumer, ids);
commands::streams::xclaim(
self,
key,
group,
consumer,
min_idle_time,
ids,
idle,
time,
retry_count,
force,
justid,
)
.await?
.into_xread_value()
}
}
/// In the context of a stream consumer group, this command changes the ownership of a pending message,
/// so that the new owner is the consumer specified as the command argument.
///
/// <https://redis.io/commands/xclaim>
///
/// **See [xclaim_values](Self::xclaim_values) for a variation of this function that might be more useful.**
fn xclaim<R, K, G, C, I>(
&self,
key: K,
group: G,
consumer: C,
min_idle_time: u64,
ids: I,
idle: Option<u64>,
time: Option<u64>,
retry_count: Option<u64>,
force: bool,
justid: bool,
) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
G: Into<Str> + Send,
C: Into<Str> + Send,
I: Into<MultipleIDs> + Send,
{
async move {
into!(key, group, consumer, ids);
commands::streams::xclaim(
self,
key,
group,
consumer,
min_idle_time,
ids,
idle,
time,
retry_count,
force,
justid,
)
.await?
.convert()
}
}
/// This command transfers ownership of pending stream entries that match the specified criteria. It also converts
/// the response type to a less verbose type declaration and handles potential differences between RESP2 and RESP3.
///
/// <https://redis.io/commands/xautoclaim>
// FIXME: this type declaration wont work for Redis v7. Probably need a new FF for this...
fn xautoclaim_values<Ri, Rk, Rv, K, G, C, I>(
&self,
key: K,
group: G,
consumer: C,
min_idle_time: u64,
start: I,
count: Option<u64>,
justid: bool,
) -> impl Future<Output = RedisResult<(String, Vec<XReadValue<Ri, Rk, Rv>>)>> + Send
where
Ri: FromRedis,
Rk: FromRedisKey + Hash + Eq,
Rv: FromRedis,
K: Into<RedisKey> + Send,
G: Into<Str> + Send,
C: Into<Str> + Send,
I: Into<XID> + Send,
{
async move {
into!(key, group, consumer, start);
commands::streams::xautoclaim(self, key, group, consumer, min_idle_time, start, count, justid)
.await?
.into_xautoclaim_values()
}
}
/// This command transfers ownership of pending stream entries that match the specified criteria.
///
/// <https://redis.io/commands/xautoclaim>
///
/// **Note: See [xautoclaim_values](Self::xautoclaim_values) for a variation of this function that may be more
/// useful.**
fn xautoclaim<R, K, G, C, I>(
&self,
key: K,
group: G,
consumer: C,
min_idle_time: u64,
start: I,
count: Option<u64>,
justid: bool,
) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
G: Into<Str> + Send,
C: Into<Str> + Send,
I: Into<XID> + Send,
{
async move {
into!(key, group, consumer, start);
commands::streams::xautoclaim(self, key, group, consumer, min_idle_time, start, count, justid)
.await?
.convert()
}
}
/// Inspect the list of pending messages in a consumer group.
///
/// <https://redis.io/commands/xpending>
fn xpending<R, K, G, A>(&self, key: K, group: G, args: A) -> impl Future<Output = RedisResult<R>> + Send
where
R: FromRedis,
K: Into<RedisKey> + Send,
G: Into<Str> + Send,
A: Into<XPendingArgs> + Send,
{
async move {
into!(key, group, args);
commands::streams::xpending(self, key, group, args).await?.convert()
}
}
}