Struct BackupOptions

#[non_exhaustive]
pub struct BackupOptions {
    pub stdin_filename: String,
    pub stdin_command: Option<CommandInput>,
    pub as_path: Option<PathBuf>,
    pub no_scan: bool,
    pub dry_run: bool,
    pub parent_opts: ParentOptions,
    pub ignore_save_opts: LocalSourceSaveOptions,
    pub ignore_filter_opts: LocalSourceFilterOptions,
}

Options for the backup command.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stdin_filename: String

Set filename to be used when backing up from stdin

stdin_command: Option<CommandInput>

Call the given command and use its output as stdin

as_path: Option<PathBuf>

Manually set backup path in snapshot

no_scan: bool

Don’t scan the backup source for its size - this disables ETA estimation for backup.

dry_run: bool

Dry-run mode: Don’t write any data or snapshot

parent_opts: ParentOptions

Options how to use a parent snapshot

ignore_save_opts: LocalSourceSaveOptions

Options how to save entries from a local source

ignore_filter_opts: LocalSourceFilterOptions

Options how to filter from a local source

Implementations

impl BackupOptions

pub fn stdin_filename(self, value: impl Into<String>) -> Self

Sets the stdin_filename field of this struct.

pub fn stdin_command(self, value: impl Into<Option<CommandInput>>) -> Self

Sets the stdin_command field of this struct.

pub fn as_path(self, value: impl Into<Option<PathBuf>>) -> Self

Sets the as_path field of this struct.

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

Sets the no_scan field of this struct.

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

Sets the dry_run field of this struct.

pub fn parent_opts(self, value: impl Into<ParentOptions>) -> Self

Sets the parent_opts field of this struct.

pub fn ignore_save_opts(self, value: impl Into<LocalSourceSaveOptions>) -> Self

Sets the ignore_save_opts field of this struct.

pub fn ignore_filter_opts( self, value: impl Into<LocalSourceFilterOptions>, ) -> Self

Sets the ignore_filter_opts field of this struct.

Trait Implementations

impl Args for BackupOptions

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 BackupOptions

fn clone(&self) -> BackupOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for BackupOptions

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 BackupOptions

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

Formats the value using the given formatter.

impl Default for BackupOptions

fn default() -> BackupOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BackupOptions

where BackupOptions: 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 BackupOptions

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 BackupOptions

fn merge(&mut self, other: Self)

Merge another object into this object.

impl Parser for BackupOptions

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 BackupOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.