Struct rustic_core::ConfigOptions

pub struct ConfigOptions {
    pub set_compression: Option<i32>,
    pub set_version: Option<u32>,
    pub set_append_only: Option<bool>,
    pub set_treepack_size: Option<ByteSize>,
    pub set_treepack_size_limit: Option<ByteSize>,
    pub set_treepack_growfactor: Option<u32>,
    pub set_datapack_size: Option<ByteSize>,
    pub set_datapack_growfactor: Option<u32>,
    pub set_datapack_size_limit: Option<ByteSize>,
    pub set_min_packsize_tolerate_percent: Option<u32>,
    pub set_max_packsize_tolerate_percent: Option<u32>,
    pub set_extra_verify: Option<bool>,
}

Options for the config command, used to set repository-wide options

Fields

set_compression: Option<i32>

Set compression level. Allowed levels are 1 to 22 and -1 to -7, see https://facebook.github.io/zstd/. Note that 0 equals to no compression

set_version: Option<u32>

Set repository version. Allowed versions: 1,2

set_append_only: Option<bool>

Set append-only mode. Note that only append-only commands work once this is set. forget, prune or config won’t work any longer.

set_treepack_size: Option<ByteSize>

Set default packsize for tree packs. rustic tries to always produce packs greater than this value. Note that for large repos, this value is grown by the grown factor. Defaults to 4 MiB if not set.

set_treepack_size_limit: Option<ByteSize>

Set upper limit for default packsize for tree packs. Note that packs actually can get a bit larger. If not set, pack sizes can grow up to approximately 4 GiB.

set_treepack_growfactor: Option<u32>

Set grow factor for tree packs. The default packsize grows by the square root of the total size of all tree packs multiplied with this factor. This means 32 kiB times this factor per square root of total treesize in GiB. Defaults to 32 (= 1MB per square root of total treesize in GiB) if not set.

set_datapack_size: Option<ByteSize>

Set default packsize for data packs. rustic tries to always produce packs greater than this value. Note that for large repos, this value is grown by the grown factor. Defaults to 32 MiB if not set.

set_datapack_growfactor: Option<u32>

Set grow factor for data packs. The default packsize grows by the square root of the total size of all data packs multiplied with this factor. This means 32 kiB times this factor per square root of total datasize in GiB. Defaults to 32 (= 1MB per square root of total datasize in GiB) if not set.

set_datapack_size_limit: Option<ByteSize>

Set upper limit for default packsize for tree packs. Note that packs actually can get a bit larger. If not set, pack sizes can grow up to approximately 4 GiB.

set_min_packsize_tolerate_percent: Option<u32>

Set minimum tolerated packsize in percent of the targeted packsize. Defaults to 30 if not set.

set_max_packsize_tolerate_percent: Option<u32>

Set maximum tolerated packsize in percent of the targeted packsize A value of 0 means packs larger than the targeted packsize are always tolerated. Default if not set: larger packfiles are always tolerated.

set_extra_verify: Option<bool>

Do an extra verification by decompressing/decrypting all data before uploading to the repository. Default: true

Implementations

impl ConfigOptions

pub fn set_compression(self, value: impl Into<Option<i32>>) -> Self

Sets the set_compression field of this struct.

pub fn set_version(self, value: impl Into<Option<u32>>) -> Self

Sets the set_version field of this struct.

pub fn set_append_only(self, value: impl Into<Option<bool>>) -> Self

Sets the set_append_only field of this struct.

pub fn set_treepack_size(self, value: impl Into<Option<ByteSize>>) -> Self

Sets the set_treepack_size field of this struct.

pub fn set_treepack_size_limit(self, value: impl Into<Option<ByteSize>>) -> Self

Sets the set_treepack_size_limit field of this struct.

pub fn set_treepack_growfactor(self, value: impl Into<Option<u32>>) -> Self

Sets the set_treepack_growfactor field of this struct.

pub fn set_datapack_size(self, value: impl Into<Option<ByteSize>>) -> Self

Sets the set_datapack_size field of this struct.

pub fn set_datapack_growfactor(self, value: impl Into<Option<u32>>) -> Self

Sets the set_datapack_growfactor field of this struct.

pub fn set_datapack_size_limit(self, value: impl Into<Option<ByteSize>>) -> Self

Sets the set_datapack_size_limit field of this struct.

pub fn set_min_packsize_tolerate_percent( self, value: impl Into<Option<u32>>, ) -> Self

Sets the set_min_packsize_tolerate_percent field of this struct.

pub fn set_max_packsize_tolerate_percent( self, value: impl Into<Option<u32>>, ) -> Self

Sets the set_max_packsize_tolerate_percent field of this struct.

pub fn set_extra_verify(self, value: impl Into<Option<bool>>) -> Self

Sets the set_extra_verify field of this struct.

impl ConfigOptions

pub fn apply(&self, config: &mut ConfigFile) -> RusticResult<()>

Apply the ConfigOptions to a given ConfigFile

Arguments

• config - The config to apply the options to

Errors

• CommandErrorKind::VersionNotSupported - If the version is not supported
• CommandErrorKind::CannotDowngrade - If the version is lower than the current version
• CommandErrorKind::NoCompressionV1Repo - If compression is set for a v1 repo
• CommandErrorKind::CompressionLevelNotSupported - If the compression level is not supported
• CommandErrorKind::SizeTooLarge - If the size is too large
• CommandErrorKind::MinPackSizeTolerateWrong - If the min packsize tolerate percent is wrong
• CommandErrorKind::MaxPackSizeTolerateWrong - If the max packsize tolerate percent is wrong

Trait Implementations

impl Args for ConfigOptions

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

impl Clone for ConfigOptions

fn clone(&self) -> ConfigOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for ConfigOptions

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for ConfigOptions

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

Formats the value using the given formatter.

impl Default for ConfigOptions

fn default() -> ConfigOptions

Returns the “default value” for a type.

impl FromArgMatches for ConfigOptions

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for ConfigOptions

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Copy for ConfigOptions