Struct File 

pub struct File(/* private fields */);

Available on crate feature file-backend only.

A file-backed backend.

Note: this requires its futures to be executed on the Tokio 0.3 runtime.

Implementations

impl File

pub async fn from_path<P>(path: P) -> Result<Self, Error>

where P: AsRef<Path>,

Creates the backend by opening the file at the given path.

Errors

If the file does not exist or could not be opened for reading and writing, an error variant is returned.

pub async fn from_path_or_create<P>(path: P) -> Result<(Self, bool), Error>

where P: AsRef<Path>,

Creates the backend by opening a file at the given path. Creates the file if it does not exist yet.

Errors

If the file does not exist, but could not be created, or could not be opened for reading and writing, an error variant is returned.

Trait Implementations

impl Backend for File

type Error = Error

fn read<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Read all data from the backend.

fn write<'life0, 'async_trait>( &'life0 mut self, data: Vec<u8>, ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Overwrite the backend with the given data.

impl Debug for File

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

Formats the value using the given formatter.