Struct FileRecorder

pub struct FileRecorder { /* private fields */ }

A recorder that writes events to a file.

The serialization format is determined by the file extension. Supported extensions are .bin for Bincode and .json for JSON.

Implementations

impl FileRecorder

pub fn new(path: &Path) -> Result<FileRecorder, MuseError>

Creates a new FileRecorder.

Arguments

• path: The file path to write recordings to.

Errors

Returns a MuseError::Recording if the file cannot be opened.

Trait Implementations

impl Recorder for FileRecorder

fn record<'life0, 'async_trait>( &'life0 mut self, event: RecordedEventWithTime, ) -> Pin<Box<dyn Future<Output = Result<(), MuseError>> + Send + 'async_trait>>

where 'life0: 'async_trait, FileRecorder: 'async_trait,

Records an event to the file.

Arguments

• event: The [RecordedEvent] to record.

Errors

Returns a MuseError::Recording if serialization fails.

fn flush<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), MuseError>> + Send + 'async_trait>>

where 'life0: 'async_trait, FileRecorder: 'async_trait,

Flushes the writer.

Errors

Returns a MuseError::Recording if flushing fails.

fn close<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), MuseError>> + Send + 'async_trait>>

where 'life0: 'async_trait, FileRecorder: 'async_trait,

Closes the recorder by flushing the writer.

Errors

Returns a MuseError::Recording if flushing fails.