Struct redis_ts::TsRangeQuery

pub struct TsRangeQuery { /* private fields */ }

Let’s you build a ts range query with all options via a builder pattern:

use redis_ts::{TsAggregationType, TsBucketTimestamp, TsRangeQuery};
let query = TsRangeQuery::default()
    .from(1234)
    .to(5678)
    .latest(true)
    .filter_by_value(1.0, 5.0)
    .aggregation_type(TsAggregationType::Avg(5000))
    .bucket_timestamp(TsBucketTimestamp::High)
    .empty(true);

Implementations

impl TsRangeQuery

pub fn from<T: Into<Integer>>(self, from: T) -> Self

Start timestamp of the series to query. Defaults to ‘-’ (earliest sample) if left empty.

pub fn to<T: Into<Integer>>(self, to: T) -> Self

End timestamp of the series to query. Defaults to ‘+’ (latest sample) if left empty.

pub fn latest(self, latest: bool) -> Self

Will enable the LATEST flag on the query.

pub fn filter_by_ts<T: Into<Integer>>(self, ts: Vec<T>) -> Self

Will enable the FILTER_BY_TS option with given timestamps. Will only be added if the given Vec contains any ts values.

pub fn filter_by_value(self, min: f64, max: f64) -> Self

Will enable the FILTER_BY_VALUE option with given min and max values.

pub fn count(self, count: u64) -> Self

Determines the max amount of returned samples.

pub fn align(self, align: TsAlign) -> Self

Controls the aggregation alignment. Will only be added if the query actually contains aggregation params.

pub fn aggregation_type(self, aggregation_type: TsAggregationType) -> Self

The type of aggregation to be performed on the series.

pub fn bucket_timestamp(self, bucket_timestamp: TsBucketTimestamp) -> Self

Controls reporting of aggregation bucket timestamps. Will only be added if the query actually contains aggregation params.

pub fn empty(self, empty: bool) -> Self

Enables the EMPTY flag on the query.

Trait Implementations

impl Clone for TsRangeQuery

fn clone(&self) -> TsRangeQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TsRangeQuery

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

Formats the value using the given formatter.

impl Default for TsRangeQuery

fn default() -> TsRangeQuery

Returns the “default value” for a type.

impl ToRedisArgs for TsRangeQuery

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.