Struct LocalBackend

pub struct LocalBackend { /* private fields */ }

A local backend.

Implementations

impl LocalBackend

pub fn new( path: impl AsRef<str>, options: impl IntoIterator<Item = (String, String)>, ) -> RusticResult<Self>

Create a new LocalBackend

Arguments

• path - The base path of the backend
• options - Additional options for the backend

Errors

• If the directory could not be created.

Options

• post-create-command - The command to call after a file was created.
• post-delete-command - The command to call after a file was deleted.

Trait Implementations

impl Clone for LocalBackend

fn clone(&self) -> LocalBackend

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LocalBackend

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

Formats the value using the given formatter.

impl ReadBackend for LocalBackend

fn location(&self) -> String

Returns the location of the backend.

This is local:<path>.

fn list(&self, tpe: FileType) -> RusticResult<Vec<Id>>

Lists all files of the given type.

Arguments

• tpe - The type of the files to list.

Notes

If the file type is FileType::Config, this will return a list with a single default id.

fn list_with_size(&self, tpe: FileType) -> RusticResult<Vec<(Id, u32)>>

Lists all files with their size of the given type.

Arguments

• tpe - The type of the files to list.

Errors

• If the metadata of the file could not be queried.
• If the length of the file could not be converted to u32.
• If the metadata of the file could not be queried.

fn read_full(&self, tpe: FileType, id: &Id) -> RusticResult<Bytes>

Reads full data of the given file.

Arguments

• tpe - The type of the file.
• id - The id of the file.

Errors

• If the file could not be read.
• If the file could not be found.

fn read_partial( &self, tpe: FileType, id: &Id, _cacheable: bool, offset: u32, length: u32, ) -> RusticResult<Bytes>

Reads partial data of the given file.

Arguments

• tpe - The type of the file.
• id - The id of the file.
• cacheable - Whether the file is cacheable.
• offset - The offset to read from.
• length - The length to read.

Errors

• If the file could not be opened.
• If the file could not be sought to the given position.
• If the length of the file could not be converted to u32.
• If the exact length of the file could not be read.

fn needs_warm_up(&self) -> bool

Specify if the backend needs a warming-up of files before accessing them.

fn warm_up(&self, _tpe: FileType, _id: &Id) -> Result<(), Box<RusticError>>

Warm-up the given file.

impl WriteBackend for LocalBackend

fn create(&self) -> RusticResult<()>

Create a repository on the backend.

Errors

• If the directory could not be created.

fn write_bytes( &self, tpe: FileType, id: &Id, _cacheable: bool, buf: Bytes, ) -> RusticResult<()>

Write the given bytes to the given file.

Arguments

• tpe - The type of the file.
• id - The id of the file.
• cacheable - Whether the file is cacheable.
• buf - The bytes to write.

Errors

• If the file could not be opened.
• If the length of the bytes could not be converted to u64.
• If the length of the file could not be set.
• If the bytes could not be written to the file.
• If the OS Metadata could not be synced to disk.
• If the file does not have a parent directory.
• If the parent directory could not be created.
• If the file cannot be opened, due to missing permissions.
• If the file cannot be written to, due to lack of space on the disk.

fn remove(&self, tpe: FileType, id: &Id, _cacheable: bool) -> RusticResult<()>

Remove the given file.

Arguments

• tpe - The type of the file.
• id - The id of the file.
• cacheable - Whether the file is cacheable.

Errors

• If the file could not be removed.