Struct GlobalOptions 

pub struct GlobalOptions {

    pub use_profiles: Vec<String>,
    pub group_by: Option<SnapshotGroupCriterion>,
    pub dry_run: bool,
    pub check_index: bool,
    pub log_level: Option<String>,
    pub log_file: Option<PathBuf>,
    pub progress_options: ProgressOptions,
    pub hooks: Hooks,
    pub env: BTreeMap<String, String>,
    pub prometheus: Option<Url>,
    pub prometheus_user: Option<String>,
    pub prometheus_pass: Option<String>,
    pub metrics_labels: BTreeMap<String, String>,
    pub opentelemetry: Option<Url>,
}

Global options

These options are available for all commands.

Fields

use_profiles: Vec<String>

Config profile to use. This parses the file <PROFILE>.toml in the config directory. [default: “rustic”]

group_by: Option<SnapshotGroupCriterion>

Group snapshots by any combination of host,label,paths,tags, e.g. to find the latest snapshot [default: “host,label,paths”]

dry_run: bool

Only show what would be done without modifying anything. Does not affect read-only commands.

check_index: bool

Check if index matches pack files and read pack headers if necessary

log_level: Option<String>

Use this log level [default: info]

log_file: Option<PathBuf>

Write log messages to the given file instead of printing them.

Note

Warnings and errors are still additionally printed unless they are ignored by --log-level

progress_options: ProgressOptions

Settings to customize progress bars

hooks: Hooks

Hooks

env: BTreeMap<String, String>

List of environment variables to set (only in config file)

prometheus: Option<Url>

Push metrics to a Prometheus Pushgateway

prometheus_user: Option<String>

Authenticate to Prometheus Pushgateway using this user

prometheus_pass: Option<String>

Authenticate to Prometheus Pushgateway using this password

metrics_labels: BTreeMap<String, String>

Additional labels to set to generated metrics

opentelemetry: Option<Url>

OpenTelemetry metrics endpoint (HTTP Protobuf)

Implementations

impl GlobalOptions

pub fn is_metrics_configured(&self) -> bool

Trait Implementations

impl Args for GlobalOptions

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 via FromArgMatches::from_arg_matches_mut

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

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for GlobalOptions

fn clone(&self) -> GlobalOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for GlobalOptions

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 GlobalOptions

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

Formats the value using the given formatter.

impl Default for GlobalOptions

fn default() -> GlobalOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GlobalOptions

where GlobalOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for GlobalOptions

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 Merge for GlobalOptions

fn merge(&mut self, other: Self)

Merge another object into this object.

impl Parser for GlobalOptions

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 Serialize for GlobalOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.