Struct cucumber::cli::Opts

pub struct Opts<Parser, Runner, Writer, Custom = Empty>where
    Parser: Args,
    Runner: Args,
    Writer: Args,
    Custom: Args,{
    pub re_filter: Option<Regex>,
    pub tags_filter: Option<TagOperation>,
    pub parser: Parser,
    pub runner: Runner,
    pub writer: Writer,
    pub custom: Custom,
}

Root CLI (command line interface) of a top-level Cucumber executor.

It combines all the nested CLIs of Parser, Runner and Writer, and may be extended with custom CLI options additionally.

Example

#[derive(clap::Args)] // also re-exported as `cli::Args`
struct CustomOpts {
    /// Additional time to wait in before hook.
    #[arg(
        long,
        value_parser = humantime::parse_duration,
    )]
    pre_pause: Option<Duration>,
}

let opts = cli::Opts::<_, _, _, CustomOpts>::parsed();
let pre_pause = opts.custom.pre_pause.unwrap_or_default();

MyWorld::cucumber()
    .before(move |_, _, _, _| time::sleep(pre_pause).boxed_local())
    .with_cli(opts)
    .run_and_exit("tests/features/readme")
    .await;

Fields

re_filter: Option<Regex>

Regex to filter scenarios by their name.

tags_filter: Option<TagOperation>

Tag expression to filter scenarios by.

Note: Tags from Feature, Rule and Scenario are merged together on filtering, so be careful about conflicting tags on different levels.

parser: Parser

Parser CLI options.

runner: Runner

Runner CLI options.

writer: Writer

Writer CLI options.

custom: Custom

Additional custom CLI options.

Implementations

impl<Parser, Runner, Writer, Custom> Opts<Parser, Runner, Writer, Custom>where
    Parser: Args,
    Runner: Args,
    Writer: Args,
    Custom: Args,

pub fn parsed() -> Self

Shortcut for clap::Parser::parse(), which doesn’t require the trait being imported.

Trait Implementations

impl<Parser, Runner, Writer, Custom> Args for Opts<Parser, Runner, Writer, Custom>where
    Parser: Args,
    Runner: Args,
    Writer: Args,
    Custom: Args,

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.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

impl<Parser, Runner, Writer, Custom> Clone for Opts<Parser, Runner, Writer, Custom>where
    Parser: Args + Clone,
    Runner: Args + Clone,
    Writer: Args + Clone,
    Custom: Args + Clone,

fn clone(&self) -> Opts<Parser, Runner, Writer, Custom>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Parser, Runner, Writer, Custom> CommandFactory for Opts<Parser, Runner, Writer, Custom>where
    Parser: Args,
    Runner: Args,
    Writer: Args,
    Custom: Args,

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<Parser, Runner, Writer, Custom> Debug for Opts<Parser, Runner, Writer, Custom>where
    Parser: Args + Debug,
    Runner: Args + Debug,
    Writer: Args + Debug,
    Custom: Args + Debug,

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

Formats the value using the given formatter.

impl<Parser, Runner, Writer, Custom> Default for Opts<Parser, Runner, Writer, Custom>where
    Parser: Args + Default,
    Runner: Args + Default,
    Writer: Args + Default,
    Custom: Args + Default,

fn default() -> Opts<Parser, Runner, Writer, Custom>

Returns the “default value” for a type.

impl<Parser, Runner, Writer, Custom> FromArgMatches for Opts<Parser, Runner, Writer, Custom>where
    Parser: Args,
    Runner: Args,
    Writer: Args,
    Custom: Args,

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, Runner, Writer, Custom> Parser for Opts<Parser, Runner, Writer, Custom>where
    Parser: Args,
    Runner: Args,
    Writer: Args,
    Custom: Args,

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error<RichFormatter>>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere
    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<RichFormatter>>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<RichFormatter>>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, return Err on error.