Struct redis_ts::TsFilterOptions

pub struct TsFilterOptions { /* private fields */ }

Let’s you build redis time series filter query options via a builder pattern. Filters can be used in different commands like TS.MGET, TS.MRANGE and TS.QUERYINDEX.

Implementations

impl TsFilterOptions

TsFilterOptions allows you to build up your redis time series filter query. It supports default and a builder pattern so you can use it the following way:

use redis_ts::TsFilterOptions;

let filters = TsFilterOptions::default()
    .with_labels(true)
    .equals("label_1", "value_1")
    .not_equals("label_2", "hello")
    .in_set("label_3", vec!["a", "b", "c"])
    .not_in_set("label_3", vec!["d", "e"])
    .has_label("some_other")
    .not_has_label("unwanted");

pub fn with_labels(self, value: bool) -> Self

Will add the WITHLABELS flag to the filter query. The query response will have label information attached.

pub fn equals<L: Display + ToRedisArgs, V: Display + ToRedisArgs>( self, name: L, value: V ) -> Self

Select time series where the given label contains the the given value.

pub fn not_equals<L: Display + ToRedisArgs, V: Display + ToRedisArgs>( self, name: L, value: V ) -> Self

Select time series where given label does not contain the given value.

pub fn in_set<L: Display + ToRedisArgs, V: Display + ToRedisArgs>( self, name: L, values: Vec<V> ) -> Self

Select time series where given label contains any of the given values.

pub fn not_in_set<L: Display + ToRedisArgs, V: Display + ToRedisArgs>( self, name: L, values: Vec<V> ) -> Self

Select time series where given label does not contain any of the given values.

pub fn has_label<L: Display + ToRedisArgs>(self, name: L) -> Self

Select all time series that have the given label.

pub fn not_has_label<L: Display + ToRedisArgs>(self, name: L) -> Self

Select all time series that do not have the given label.

pub fn get_filters(self) -> Vec<TsFilter>

Trait Implementations

impl Clone for TsFilterOptions

fn clone(&self) -> TsFilterOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TsFilterOptions

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

Formats the value using the given formatter.

impl Default for TsFilterOptions

fn default() -> TsFilterOptions

Returns the “default value” for a type.

impl ToRedisArgs for TsFilterOptions

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.

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.

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

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.