Crate rustic_backend

A library for supporting various backends in rustic.

Overview

This section gives a brief overview of the primary types in this crate:

rustic_backend is a support crate for rustic_core which provides a way to access a repository using different backends.

The primary types in this crate are:

• BackendOptions - A struct for configuring options for a used backend.
• SupportedBackend - An enum for the supported backends.

The following backends are currently supported and can be enabled with features:

• LocalBackend - Backend for accessing a local filesystem.
• OpenDALBackend - Backend for accessing a OpenDAL filesystem.
• RcloneBackend - Backend for accessing a Rclone filesystem.
• RestBackend - Backend for accessing a REST API.
• SftpBackend - Backend for accessing a SFTP filesystem.
• S3Backend - Backend for accessing a S3 filesystem.

Usage & Examples

Due to being a support crate for rustic_core, there are no examples here. Please check the examples in the rustic_core crate.

Crate features

This crate exposes a few features for controlling dependency usage:

• cli - Enables support for CLI features by enabling merge and clap features. This feature is disabled by default.

• clap - Enables a dependency on the clap crate and enables parsing from the commandline. This feature is disabled by default.

• merge - Enables support for merging multiple values into one, which enables the merge dependency. This is needed for parsing commandline arguments and merging them into one (e.g. config). This feature is disabled by default.

Backend-related features

• opendal - Enables support for the opendal backend. This feature is enabled by default.

• rclone - Enables support for the rclone backend. This feature is enabled by default.

• rest - Enables support for the rest backend. This feature is enabled by default.

• sftp - Enables support for the sftp backend. Windows is not yet supported. This feature is enabled by default.

• s3 - Enables support for the s3 backend. This feature is enabled by default.

Re-exports

• pub use crate::choose::BackendOptions;
• pub use crate::choose::SupportedBackend;
• pub use crate::local::LocalBackend;
• pub use crate::opendal::sftp::SftpBackend;
• pub use crate::opendal::s3::S3Backend;
• pub use crate::opendal::OpenDALBackend;
• pub use crate::rclone::RcloneBackend;
• pub use crate::rest::RestBackend;

Modules

• choose
  This module contains BackendOptions and helpers to choose a backend from a given url.
• error
• local
• opendal
• rclone
• rest
• util