Struct structopt_flags::ConfigFile

pub struct ConfigFile { /* fields omitted */ }

This struct provides the --config_file cli option

The option is mandatory and require a filename

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

use structopt::StructOpt;
use structopt_flags::ConfigFile; // to access get_log_level

#[derive(Debug, StructOpt)]
#[structopt(name = "config-file", about = "An example using config_file option")]
struct Opt {
    #[structopt(flatten)]
    config: structopt_flags::ConfigFile,
}

fn main() {
    let opt = Opt::from_args();
    let config_file = opt.config.get_filename();
    // use the config file
}

Methods

impl ConfigFile

pub fn get_filename(&self) -> PathBuf

Trait Implementations

impl Clone for ConfigFile

fn clone(&self) -> ConfigFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for ConfigFile

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

Formats the value using the given formatter.

impl Debug for ConfigFile

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

Formats the value using the given formatter.

impl StructOpt for ConfigFile

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.