Struct structopt_flags::ForceFlag

pub struct ForceFlag {
    pub force: bool,
}

This struct implements the --force cli option as a boolean flag

The short form is '-f'

extern crate structopt_flags;
#[macro_use]
extern crate structopt;

use structopt::StructOpt;

#[derive(Debug, StructOpt)]
#[structopt(name = "force", about = "An example using force flag")]
struct Opt {
    #[structopt(flatten)]
    force_flag: structopt_flags::ForceFlag,
}

fn main() {
    let opt = Opt::from_args();
    if opt.force_flag.force {
        println!("Force operation");
    } else {
        println!("No forced behavior ");
    }
}

Fields

force: bool

Force the operation

Trait Implementations

impl Clone for ForceFlag

fn clone(&self) -> ForceFlag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ForceFlag

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

Formats the value using the given formatter.

impl Display for ForceFlag

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

Formats the value using the given formatter.

impl StructOpt for ForceFlag

fn clap<'a, 'b>() -> App<'a, 'b>

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches) -> Self

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.