Struct Client 

pub struct Client { /* private fields */ }

A single Redis endpoint housing an audit log.

Implementations

impl Client

pub fn connect(url: &str) -> AudisResult<Client>

Connect to a Redis instance, by URL.

This implementation understands the same URL formats that the underlying redis crate understands. Primarily, this means the following should work:

• redis://127.0.0.1:6379
• redis://localhost
• unix:/path/to/redis.sock

pub fn background( &self, n: usize, ) -> AudisResult<(SyncSender<Event>, JoinHandle<()>)>

Delegate event logging to a background thread.

This function spins up a new thread, with a copy of the audis Client object, and returns a channel for sending new audis::Event objects to be logged, and the thread JoinHandle for waiting on the thread to finish.

The sending channel is buffered, and will have enough space to keep n Event objects in memory. If n is passed as zero, a suitable default will be used instead.

If the background thread encounters an error while trying to log an Event to the Redis backend, it will print out the error and attempt to recover.

To shut down the background thread, drop the returned SyncSender object and then join the thread’s JoinHandle.

pub fn subjects(&self) -> AudisResult<Vec<String>>

Return the list of all known subjects.

pub fn log(&self, e: &Event) -> AudisResult<&Client>

Log an event to the audit log.

pub fn retrieve(&self, log: &str) -> AudisResult<Vec<Event>>

Retrieve the full list of events for the given subject.

pub fn truncate(&self, log: &str, n: u32) -> AudisResult<&Client>

Truncate a subject so that it only contains n Events.

pub fn purge(&self, log: &str, last: &str) -> AudisResult<&Client>

Delete the Event last and all prior events from a given subject.