Struct TimeSeries 

pub struct TimeSeries<T> { /* private fields */ }

Connection to a Redis Time Series

This contains a connection to the Redis database that can be used to create, delete, and interact with a single time series.

To be completely readable and writeable, the data type, T must implement the traits Clone, serde::Serialize and serde::DeserializeOwned.

Implementations

impl<T> TimeSeries<T>

pub fn new(namespace: &str, name: &str) -> Result<Self>

Creates a new connection to the named time series.

pub fn with_host(host: &str, namespace: &str, name: &str) -> Result<Self>

Creates a new connection to the named time series on the specified host.

pub fn with_uri(uri: &str, namespace: &str, name: &str) -> Result<Self>

Creates a new connection to the named time series on the host with the specified URI.

pub fn purge_before<S>(&mut self, ts: S) -> Result<()>

where S: Into<Timestamp>,

Deletes all the values in the time series before the specified time stamp, ts.

pub fn purge_older_than(&mut self, dur: Duration) -> Result<()>

Deletes all the values in the time series older than the specified duration.

This deletes all the data except points that fall in the most recent time specified by the duration.

pub fn delete(&mut self) -> Result<()>

Removes the entire timeseries from the Redis DB.

impl<T: Serialize> TimeSeries<T>

pub fn add<S>(&mut self, ts: S, val: T) -> Result<()>

where S: Into<Timestamp>,

Adds a point to the time series.

pub fn add_now(&mut self, val: T) -> Result<()>

Adds a point to the time series, using the current time as the timestamp.

pub fn add_value<V>(&mut self, val: V) -> Result<()>

where V: Into<TimeValue<T>>,

Adds a point to the time series as a TimeValue.

pub fn add_multiple(&mut self, vals: &[TimeValue<T>]) -> Result<()>

Adds multiple points to the time series.

pub fn add_multiple_values(&mut self, vals: &[(Timestamp, T)]) -> Result<()>

Adds multiple points to the time series from a slice of tuples.

impl<T: DeserializeOwned> TimeSeries<T>

pub fn get_range_any<S, U>( &mut self, ts1: S, ts2: U, ) -> Result<Vec<TimeValue<T>>>

where S: ToRedisArgs, U: ToRedisArgs,

Gets values from an arbitrary time range. The timestamps can be floating point values, or anything that can be converted to a Redis argument, such as special strings like “-inf”, “+inf”, or “2.0)” to indicate open ranges.

pub fn get_range<S, U>(&mut self, ts1: S, ts2: U) -> Result<Vec<TimeValue<T>>>

where S: Into<Timestamp>, U: Into<Timestamp>,

Gets values from a time range. This gets the values from ts1 up to, but not including, ts2.

pub fn get_from<S>(&mut self, ts: S) -> Result<Vec<TimeValue<T>>>

where S: Into<Timestamp>,

Gets values starting from the specified time up to the latest value.

pub fn get_last(&mut self, dur: Duration) -> Result<Vec<TimeValue<T>>>

Gets the most recent points for the specified duration.

pub fn get_all(&mut self) -> Result<Vec<TimeValue<T>>>

Gets all the values in the series. This should be used with caution if the series is large.