Expand description
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 aOpenDALfilesystem.RcloneBackend- Backend for accessing a Rclone filesystem.RestBackend- Backend for accessing a REST API.
§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
mergeandclapfeatures. This feature is disabled by default. -
clap - Enables a dependency on the
clapcrate and enables parsing from the commandline. This feature is disabled by default. -
merge - Enables support for merging multiple values into one, which enables the
conflatedependency. 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
opendalbackend. This feature is enabled by default. -
rclone - Enables support for the
rclonebackend. This feature is enabled by default. -
rest - Enables support for the
restbackend. This feature is enabled by default.
Re-exports§
pub use crate::opendal::OpenDALBackend;pub use crate::rclone::RcloneBackend;pub use crate::rest::RestBackend;pub use crate::choose::BackendOptions;pub use crate::choose::SupportedBackend;pub use crate::local::LocalBackend;
Modules§
- choose
- This module contains
BackendOptionsand helpers to choose a backend from a given url. - local
- Local backend for Rustic.
- opendal
OpenDALbackend for Rustic.- rclone
Rclonebackend for Rustic.- rest
- REST backend for Rustic.
- util
- Utility functions for the backend.
Structs§
- Rustic
Error - Errors that can result from rustic.
Enums§
- Error
Kind ErrorKinddescribes the errors that can happen while executing a high-level command.- Severity
- Severity of an error, ranging from informational to fatal.
- Status
- Status of an error, indicating whether it is permanent, temporary, or persistent.
Type Aliases§
- Rustic
Result - Result type that is being returned from methods that can fail and thus have
RusticErrors.