Struct daybreak::backend::PathBackend

pub struct PathBackend { /* private fields */ }

A Backend using a file given the path.

Features atomic saves, so that the database file won’t be corrupted or deleted if the program panics during the save.

Implementations

impl PathBackend

pub fn from_path_or_fail(path: PathBuf) -> BackendResult<Self>

Opens a new PathBackend for a given path. Errors when the file doesn’t yet exist.

pub fn from_path_or_create(path: PathBuf) -> BackendResult<(Self, bool)>

Opens a new PathBackend for a given path. Creates a file if it doesn’t yet exist.

Returns the PathBackend and whether the file already existed.

pub fn from_path_or_create_and<C>(
    path: PathBuf,
    closure: C
) -> BackendResult<Self>where
    C: FnOnce(&mut File),

Opens a new PathBackend for a given path. Creates a file if it doesn’t yet exist, and calls closure with it.

Trait Implementations

impl Backend for PathBackend

fn put_data(&mut self, data: &[u8]) -> BackendResult<()>

Write the byte slice to the backend. This uses and atomic save.

This won’t corrupt the existing database file if the program panics during the save.

fn get_data(&mut self) -> BackendResult<Vec<u8>>

Read the all data from the backend.

impl Debug for PathBackend

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

Formats the value using the given formatter.