Struct Arguments 

pub struct Arguments {
    pub min_size: Option<u64>,
    pub max_size: Option<u64>,
    pub config: bool,
    pub generator: Option<Shell>,
    pub min_dimension: Option<u64>,
    pub max_dimension: Option<u64>,
    pub interval: Option<u64>,
    pub monitor: Option<u8>,
    pub monitor_orientation: Option<Orientation>,
    pub pictures_per_monitor: Option<u8>,
    pub sort: bool,
    pub verbose: bool,
}

Command line arguments

Fields

min_size: Option<u64>

Set a minimum file size (in bytes) for searching image files.

keep files whose size is greater than or equal to a minimum value.

size >= min_size

max_size: Option<u64>

Set a maximum file size (in bytes) for searching image files.

keep files whose size is less than or equal to a maximum value.

size <= max_size

config: bool

Read the configuration file and exit the program.

generator: Option<Shell>

Generate shell completions and exit the program.

How to generate shell completions for Z-shell:

Example 1 (as a regular user):

Generate completion_derive.zsh file with:

    wallswitch --generate=zsh > completion_derive.zsh

Append the contents of the completion_derive.zsh file to the end of completion zsh file.

ZSH completions are commonly stored in any directory listed in your $fpath variable.

On Linux, view $fpath variable with:

    echo $fpath | perl -nE 'say for split /\s+/'

And then, execute:

    compinit && zsh

Example 2 (as a regular user):

Generate completions to rustup and wallswitch.

Visible to only the regular user.

    mkdir -p ~/.oh-my-zsh/functions

    rustup completions zsh > ~/.oh-my-zsh/functions/_rustup

    wallswitch --generate=zsh > ~/.oh-my-zsh/functions/_wallswitch

    compinit && zsh

Example 3 (as root):

Generate completions to rustup, cargo and wallswitch.

Visible to all system users.

    mkdir -p /usr/local/share/zsh/site-functions

    rustup completions zsh > /usr/local/share/zsh/site-functions/_rustup

    rustup completions zsh cargo > /usr/local/share/zsh/site-functions/_cargo

    wallswitch --generate=zsh > /usr/local/share/zsh/site-functions/_wallswitch

    compinit && zsh

See rustup completions for detailed help.

https://github.com/clap-rs/clap/blob/master/clap_complete/examples/completion-derive.rs

min_dimension: Option<u64>

Set the minimum dimension that the height and width must satisfy.

width >= min_dimension && height >= min_dimension

Default value: min_dimension = 600.

max_dimension: Option<u64>

Set the maximum dimension that the height and width must satisfy.

width <= max_dimension && height <= max_dimension

interval: Option<u64>

Set the interval (in seconds) between each wallpaper displayed.

Default value: interval = 30 * 60 = 1800 seconds (30 minutes).

monitor: Option<u8>

Set the number of monitors [default: 2]

monitor_orientation: Option<Orientation>

Inform monitor orientation: Horizontal (side-by-side) or Vertical (stacked).

Orientation: [Horizontal, Vertical]

Default orientation: Horizontal.

pictures_per_monitor: Option<u8>

Set number of pictures (or images) per monitor [default: 1]

Each monitor can have a diferent number of pictures (or images)

Gnome desktop only

sort: bool

Sort the images found.

verbose: bool

Show intermediate runtime messages.

Show found images.

Show pid numbers of previous running program.

Implementations

impl Arguments

pub fn build() -> WallSwitchResult<Arguments>

Build Arguments struct

Trait Implementations

impl Args for Arguments

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 Arguments

fn clone(&self) -> Arguments

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Arguments

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 Arguments

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

Formats the value using the given formatter.

impl FromArgMatches for Arguments

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 Arguments

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.