Struct FileJournal 

pub struct FileJournal { /* private fields */ }

A JSONL file written from its own thread.

Journal::record only sends on a channel; the thread owns the file and does every write and flush. See the module docs for why the I/O is not on the writer thread.

Implementations

impl FileJournal

pub fn create(path: &Path) -> Result<Self>

Opens path for append and starts the writing thread.

Errors

If the file cannot be opened. Once open, later write failures are swallowed rather than reported: the caller has no useful response to “the journal could not be written”, and the one unacceptable response is refusing an op over it.

Trait Implementations

impl Debug for FileJournal

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

Formats the value using the given formatter.

impl Drop for FileJournal

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Journal for FileJournal

fn record(&self, event: Event)

Records one event. Must not block and must not panic.

fn enabled(&self) -> bool

Whether building an Event for this journal is worth it.