Struct rustic_backend::rclone::RcloneBackend

pub struct RcloneBackend { /* private fields */ }

RcloneBackend is a backend that uses rclone to access a remote backend.

Implementations

impl RcloneBackend

pub fn new( url: impl AsRef<str>, options: HashMap<String, String>, ) -> Result<Self>

Create a new RcloneBackend from a given url.

Arguments

• url - The url to create the RcloneBackend from.

Errors

• RcloneErrorKind::FromIoError - If the rclone version could not be determined.
• RcloneErrorKind::NoStdOutForRclone - If the rclone version could not be determined.
• RcloneErrorKind::RCloneExitWithBadStatus - If rclone exited with a bad status.
• RcloneErrorKind::UrlNotStartingWithHttp - If the URL does not start with http.

Returns

The created RcloneBackend.

Panics

If the rclone command is not found.

Trait Implementations

impl Debug for RcloneBackend

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

Formats the value using the given formatter.

impl Drop for RcloneBackend

fn drop(&mut self)

Kill the child process.

impl ReadBackend for RcloneBackend

fn location(&self) -> String

Returns the location of the backend.

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

Returns the size of the given file.

Arguments

• tpe - The type of the file.

If the size could not be determined.

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

Reads full data of the given file.

Arguments

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

Returns

The data read.

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

Reads partial data of the given file.

Arguments

• tpe - The type of the file.
• id - The id of the file.
• cacheable - Whether the data should be cached.
• offset - The offset to read from.
• length - The length to read.

Returns

The data read.

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

Lists all files of the given type.

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<(), Error>

Warm-up the given file.

impl WriteBackend for RcloneBackend

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

Creates a new file.

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

Writes bytes to the given file.

Arguments

• tpe - The type of the file.
• id - The id of the file.
• cacheable - Whether the data should be cached.
• buf - The data to write.

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

Removes the given file.

Arguments

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