Struct redis_ts::TsOptions

pub struct TsOptions { /* fields omitted */ }

Options for a redis time series key. Can be used in multiple redis time series calls (CREATE, ALTER, ADD, ...). The uncompressed option will only be respected in a TS.CREATE.

Implementations

impl TsOptions

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

use redis_ts::TsOptions;
 
let opts:TsOptions = TsOptions::default()
    .retention_time(60000)
    .uncompressed(false)
    .label("label_1", "value_1")
    .label("label_2", "value_2");

pub fn retention_time(self, time: u64) -> Self

Specifies the retention time in millis for this time series options.

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

Switches this time series into uncompressed mode. Note that redis ts only respects this flag in TS.CREATE. All other options usages will ignore this flag.

pub fn labels(self, labels: Vec<(&str, &str)>) -> Self

Resets all labels to the items in given labels. All labels that where previously present will be removed. If the labels are empty no labels will be used for the time series.

pub fn label(self, name: &str, value: &str) -> Self

Adds a single label to this time series options.

Trait Implementations

impl Clone for TsOptions

fn clone(&self) -> TsOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TsOptions

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

Formats the value using the given formatter.

impl Default for TsOptions

fn default() -> TsOptions

Returns the "default value" for a type.

impl ToRedisArgs for TsOptions

fn write_redis_args<W: ?Sized>(&self, out: &mut W) where
    W: 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.