redis

Struct ScanOptions

Source
pub struct ScanOptions { /* private fields */ }
Expand description

Options for the SCAN command

§Example

use redis::{Commands, RedisResult, ScanOptions, Iter};
fn force_fetching_every_matching_key<'a, T: redis::FromRedisValue>(
    con: &'a mut redis::Connection,
    pattern: &'a str,
    count: usize,
) -> RedisResult<Iter<'a, T>> {
    let opts = ScanOptions::default()
        .with_pattern(pattern)
        .with_count(count);
    con.scan_options(opts)
}

Implementations§

Source§

impl ScanOptions

Source

pub fn with_count(self, n: usize) -> Self

Limit the results to the first N matching items.

Source

pub fn with_pattern(self, p: impl Into<String>) -> Self

Pattern for scan

Source

pub fn with_type(self, t: impl Into<String>) -> Self

Limit the results to those with the given Redis type

Trait Implementations§

Source§

impl Default for ScanOptions

Source§

fn default() -> ScanOptions

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

impl ToRedisArgs for ScanOptions

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 num_of_args(&self) -> usize

Returns the number of arguments this value will generate. 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).

Auto Trait Implementations§

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.

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.

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.
Source§

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

Source§

impl<T> MaybeSendSync for T