Struct RRDCachedClient 

pub struct RRDCachedClient<T = TcpStream> { /* private fields */ }

A client to interact with a RRDCached server.

Implementations

impl RRDCachedClient<TcpStream>

pub async fn connect_tcp(addr: &str) -> Result<Self, RRDCachedClientError>

Connect to a RRDCached server over TCP.

impl RRDCachedClient<UnixStream>

pub async fn connect_unix(addr: &str) -> Result<Self, RRDCachedClientError>

Connect to a RRDCached server over a Unix socket.

impl<T> RRDCachedClient<T>

where T: AsyncRead + AsyncWrite + Unpin,

pub async fn help( &mut self, command: Option<&str>, ) -> Result<(String, Vec<String>), RRDCachedClientError>

Retreive documentation for humans.

Can take an optional command to get help for a specific command.

pub async fn ping(&mut self) -> Result<(), RRDCachedClientError>

Ping the server to check if it’s alive.

pub async fn create( &mut self, arguments: CreateArguments, ) -> Result<(), RRDCachedClientError>

Create a new RRD

pub async fn flush(&mut self, path: &str) -> Result<(), RRDCachedClientError>

Flush a RRD

pub async fn flush_all(&mut self) -> Result<(), RRDCachedClientError>

Flush all RRDs

pub async fn pending( &mut self, path: &str, ) -> Result<Vec<String>, RRDCachedClientError>

Pending updates

pub async fn forget(&mut self, path: &str) -> Result<(), RRDCachedClientError>

Forget pending updates

pub async fn queue( &mut self, ) -> Result<Vec<(String, usize)>, RRDCachedClientError>

Get the queue information

pub async fn stats( &mut self, ) -> Result<HashMap<String, i64>, RRDCachedClientError>

Get the server stats

pub async fn first( &mut self, path: &str, round_robin_archive: Option<usize>, ) -> Result<usize, RRDCachedClientError>

Get the first CDP (whatever that is)

pub async fn last(&mut self, path: &str) -> Result<usize, RRDCachedClientError>

Retrieve the last update timestamp

pub async fn info( &mut self, path: &str, ) -> Result<Vec<String>, RRDCachedClientError>

Retreive information about a RRD

pub async fn list( &mut self, recursive: bool, path: Option<&str>, ) -> Result<Vec<String>, RRDCachedClientError>

List RRDs

pub async fn suspend(&mut self, path: &str) -> Result<(), RRDCachedClientError>

Suspend a RRD

pub async fn resume(&mut self, path: &str) -> Result<(), RRDCachedClientError>

Resume a RRD

pub async fn suspend_all(&mut self) -> Result<(), RRDCachedClientError>

Suspend all RRDs

pub async fn resume_all(&mut self) -> Result<(), RRDCachedClientError>

Resume all RRDs

pub async fn quit(&mut self) -> Result<(), RRDCachedClientError>

Close the connection to the server

pub async fn update( &mut self, path: &str, timestamp: Option<usize>, data: Vec<f64>, ) -> Result<(), RRDCachedClientError>

Update a RRD with a list of values at a specific timestamp

The order is important as it must match the order of the data sources in the RRD

pub async fn update_one( &mut self, path: &str, timestamp: Option<usize>, data: f64, ) -> Result<(), RRDCachedClientError>

Update a RRD with a single value at a specific timestamp.

Convenient helper when a RRD contains only one data source.

pub async fn batch( &mut self, commands: Vec<BatchUpdate>, ) -> Result<(), RRDCachedClientError>

Batch updates.

RRDCached presents this as a more efficient way to update multiple RRDs at once. You may want to sort the updates by timestamp ascending as RDDtool will reject updates of older timestamps.

pub async fn fetch( &mut self, path: &str, consolidation_function: ConsolidationFunction, start: Option<i64>, end: Option<i64>, columns: Option<Vec<String>>, ) -> Result<FetchResponse, RRDCachedClientError>

Fetch the content of a Round Robin Database (RRD)

Note that we use the Ascii protocol, as the binary protocol is not documented and it’s unsure whether it’s consitent between versions of RRDCached or system architectures.

Trait Implementations

impl<T: Debug> Debug for RRDCachedClient<T>

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

Formats the value using the given formatter.