StreamClaimOptions in redis::streams - Rust
Description: Builder options for `xclaim_options` command.

Skip to main content

## StreamClaimOptions

# Struct StreamClaimOptions

Source

    pub struct StreamClaimOptions { /* private fields */ }

Available on crate feature `streams` only.
Expand description

Builder options for `xclaim_options` command.

## Implementations§

Source§

### impl StreamClaimOptions

Source

#### pub fn idle(self, ms: usize) -> Self

Set `IDLE <milliseconds>` cmd arg.

Source

#### pub fn time(self, ms_time: usize) -> Self

Set `TIME <Unix epoch milliseconds>` cmd arg.

Source

#### pub fn retry(self, count: usize) -> Self

Set `RETRYCOUNT <count>` cmd arg.

Source

#### pub fn with_force(self) -> Self

Set `FORCE` cmd arg to true.

Source

#### pub fn with_justid(self) -> Self

Set `JUSTID` cmd arg to true. Be advised: the response type changes with this option.

Source

#### pub fn with_lastid(self, lastid: impl Into<String>) -> Self

Set `LASTID <lastid>` cmd arg.

## Trait Implementations§

Source§

### impl Debug for StreamClaimOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl Default for StreamClaimOptions

Source§

#### fn default() -> StreamClaimOptions

Returns the “default value” for a type. Read more
Source§

### impl ToRedisArgs for StreamClaimOptions

Source§

#### fn write_redis_args<W>(&self, out: &mut W)
where W: ?Sized + RedisWrite,

This writes the value into a vector of bytes. Each item is a single argument. Most items generate a single item. Read more
Source§

#### fn to_redis_args(&self) -> Vec<Vec<u8>>

This converts the value into a vector of bytes. Each item is a single argument. Most items generate a vector of a single item. Read more
Source§

#### fn describe_numeric_behavior(&self) -> NumericBehavior

Returns an information about the contained value with regards to it’s numeric behavior in a redis context. This is used in some high level concepts to switch between different implementations of redis functions (for instance `INCR` vs `INCRBYFLOAT`).
Source§

#### fn num_of_args(&self) -> usize

Returns the number of arguments this value will generate. Read more

## Auto Trait Implementations§

§

### impl Freeze for StreamClaimOptions

§

### impl RefUnwindSafe for StreamClaimOptions

§

### impl Send for StreamClaimOptions

§

### impl Sync for StreamClaimOptions

§

### impl Unpin for StreamClaimOptions

§

### impl UnwindSafe for StreamClaimOptions

## 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.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
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.

§

### impl<T> PolicyExt for T
where T: ?Sized,

§

#### fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] only if `self` and `other` return `Action::Follow`. Read more
§

#### fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] if either `self` or `other` returns `Action::Follow`. Read more
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.
§

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

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

### impl<T> ErasedDestructor for T
where T: 'static,

§

### impl<T> MaybeSendSync for T