Skip to main content

FileTransitionLog

Struct FileTransitionLog 

Source
pub struct FileTransitionLog<T: LinkReference> { /* private fields */ }
Expand description

A versioned, checksummed append-only file journal.

Every append uses sync_all. Opening validates every complete record and removes a torn final line before further appends. Corrupt complete records and addresses too wide for the requested T are errors, never skipped. Creating a new file requires its parent directory to exist; synchronize that directory before relying on a newly created path surviving a system crash. File locking and retention are the caller’s responsibility.

Implementations§

Source§

impl<T: LinkReference> FileTransitionLog<T>

Source

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Opens or creates a journal and validates/repairs its final append.

Trait Implementations§

Source§

impl<T: Debug + LinkReference> Debug for FileTransitionLog<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: LinkReference> TransitionLog<T> for FileTransitionLog<T>

Source§

fn read_entries(&mut self) -> Result<Vec<JournalEntry<T>>>

Reads all complete records in append order.
Source§

fn append(&mut self, entry: &JournalEntry<T>) -> Result<()>

Appends and, for durable implementations, synchronizes one record.

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.