Struct StdStorage 

pub struct StdStorage { /* private fields */ }

A WalStorage backend that maps file names to a directory on the local filesystem.

Implementations

impl StdStorage

pub fn new(dir: impl AsRef<Path>) -> Result<Self>

Creates a new StdStorage rooted at the given directory.

The directory is created if it does not exist.

Errors

Returns an error if the directory cannot be created.

pub fn dir(&self) -> &Path

Returns the directory path this storage is rooted at.

Trait Implementations

impl WalStorage for StdStorage

type Error = Error

Error type returned by storage operations.

fn read_file(&self, name: &str) -> Result<Vec<u8>, Self::Error>

Reads the entire contents of the named file.

fn write_file(&mut self, name: &str, data: &[u8]) -> Result<(), Self::Error>

Creates or overwrites a file with the given contents.

fn append_file(&mut self, name: &str, data: &[u8]) -> Result<(), Self::Error>

Appends data to an existing file (or creates it).

fn remove_file(&mut self, name: &str) -> Result<(), Self::Error>

Removes a file. Implementations should not error if the file does not exist.

fn list_files(&self, suffix: &str) -> Result<Vec<String>, Self::Error>

Lists all file names that end with suffix, sorted.

fn sync_file(&mut self, name: &str) -> Result<(), Self::Error>

Ensures buffered data for the named file is durably persisted.

fn rename_file(&mut self, from: &str, to: &str) -> Result<(), Self::Error>

Atomically replaces to with from.

fn file_size(&self, name: &str) -> Result<u64, Self::Error>

Returns the size of the named file in bytes.

fn file_exists(&self, name: &str) -> bool

Returns true if the named file exists.

fn read_file_range( &self, name: &str, offset: usize, len: usize, ) -> Result<Vec<u8>, Self::Error>

Reads a byte range from the named file.