Struct redis::streams::StreamReadOptions
source · [−]pub struct StreamReadOptions { /* private fields */ }
Expand description
Builder options for xread_options
command.
Implementations
sourceimpl StreamReadOptions
impl StreamReadOptions
sourcepub fn read_only(&self) -> bool
pub fn read_only(&self) -> bool
Indicates whether the command is participating in a group and generating ACKs
sourcepub fn noack(self) -> Self
pub fn noack(self) -> Self
Sets the command so that it avoids adding the message to the PEL in cases where reliability is not a requirement and the occasional message loss is acceptable.
sourcepub fn group<GN: ToRedisArgs, CN: ToRedisArgs>(
self,
group_name: GN,
consumer_name: CN
) -> Self
pub fn group<GN: ToRedisArgs, CN: ToRedisArgs>(
self,
group_name: GN,
consumer_name: CN
) -> Self
Sets the name of a consumer group associated to the stream.
Trait Implementations
sourceimpl Debug for StreamReadOptions
impl Debug for StreamReadOptions
sourceimpl Default for StreamReadOptions
impl Default for StreamReadOptions
sourcefn default() -> StreamReadOptions
fn default() -> StreamReadOptions
Returns the “default value” for a type. Read more
sourceimpl ToRedisArgs for StreamReadOptions
impl ToRedisArgs for StreamReadOptions
sourcefn write_redis_args<W>(&self, out: &mut W) where
W: ?Sized + RedisWrite,
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
sourcefn to_redis_args(&self) -> Vec<Vec<u8>>
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
sourcefn describe_numeric_behavior(&self) -> NumericBehavior
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
). Read more
sourcefn is_single_arg(&self) -> bool
fn is_single_arg(&self) -> bool
Returns an indiciation if the value contained is exactly one
argument. It returns false if it’s zero or more than one. This
is used in some high level functions to intelligently switch
between GET
and MGET
variants. Read more
Auto Trait Implementations
impl RefUnwindSafe for StreamReadOptions
impl Send for StreamReadOptions
impl Sync for StreamReadOptions
impl Unpin for StreamReadOptions
impl UnwindSafe for StreamReadOptions
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more