Skip to main content

Journal

Struct Journal 

Source
pub struct Journal { /* private fields */ }
Expand description

An opened checksummed record file.

The caller owns all locking and domain policy.

Implementations§

Source§

impl Journal

Source

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

Creates and synchronizes a new empty journal.

Source

pub fn open(path: PathBuf) -> Result<Option<Self>>

Opens an existing journal, or returns None when it is absent.

An incomplete final line is truncated and synchronized. Corruption in any complete line is rejected.

Source

pub fn records(&self) -> &[Record]

Returns validated records in file order.

Source

pub fn append( &mut self, kind: impl Into<String>, recorded_at: impl Into<String>, value: Value, ) -> Result<()>

Appends and synchronizes one record before updating memory.

Source

pub fn replace( &mut self, records: impl IntoIterator<Item = Record>, ) -> Result<()>

Atomically replaces the file with caller-selected records.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.