Struct probe_rs_cli_util::common_options::CargoOptions

pub struct CargoOptions {
    pub bin: Option<String>,
    pub example: Option<String>,
    pub package: Option<String>,
    pub release: bool,
    pub target: Option<String>,
    pub manifest_path: Option<PathBuf>,
    pub no_default_features: bool,
    pub all_features: bool,
    pub features: Vec<String>,
    pub trailing_opts: Vec<String>,
}

Common options used when building artifacts with cargo.

Fields

bin: Option<String>

example: Option<String>

package: Option<String>

release: bool

target: Option<String>

manifest_path: Option<PathBuf>

no_default_features: bool

all_features: bool

features: Vec<String>

trailing_opts: Vec<String>

Escape hatch: all args passed after a sentinel -- end up here, unprocessed. Used to pass arguments to cargo not declared in CargoOptions.

Implementations

impl CargoOptions

pub fn help_message(bin: &str) -> String

Generates a suitable help string to append to your program’s –help. Example usage:

use probe_rs_cli_util::common_options::{FlashOptions, CargoOptions};
use probe_rs_cli_util::structopt::StructOpt;

let matches = FlashOptions::clap()
    .bin_name("cargo flash")
    .after_help(CargoOptions::help_message("cargo flash").as_str())
    .get_matches_from(std::env::args());
let opts = FlashOptions::from_clap(&matches);

pub fn to_cargo_options(&self) -> Vec<String>

Generates list of arguments to cargo from a CargoOptions. For example, if CargoOptions::release is set, resultant list will contain a "--release".

Trait Implementations

impl Debug for CargoOptions

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

Formats the value using the given formatter.

impl Default for CargoOptions

fn default() -> CargoOptions

Returns the “default value” for a type.

impl StructOpt for CargoOptions

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

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

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.