Struct Cli 

pub struct Cli {

    pub pattern: Option<String>,
    pub engine: Option<String>,
    pub case_insensitive: bool,
    pub multiline: bool,
    pub dotall: bool,
    pub unicode: Option<bool>,
    pub extended: bool,
    pub replacement: Option<String>,
    pub file: Option<String>,
    pub text: Option<String>,
    pub load: Option<String>,
    pub workspace: Option<String>,
    pub print: bool,
    pub output_pattern: bool,
    pub group: Option<String>,
    pub count: bool,
    pub json: bool,
    pub color: ColorMode,
    pub test: Option<Vec<String>>,
    pub rounded: bool,
    pub vim: bool,
    pub completions: Option<Shell>,
}

Fields

pattern: Option<String>

Initial regex pattern

engine: Option<String>

Engine to use: rust, fancy, or pcre2

case_insensitive: bool

Case-insensitive matching

multiline: bool

Multi-line mode

dotall: bool

Dot matches newline

unicode: Option<bool>

Unicode mode

extended: bool

Extended mode (ignore whitespace)

replacement: Option<String>

Initial replacement string

file: Option<String>

Read test string from file

text: Option<String>

Test string (alternative to stdin or file)

load: Option<String>

Load workspace from file

workspace: Option<String>

Use a workspace file for save/load (creates if missing)

print: bool

Print matches to stdout and exit (non-interactive batch mode). Requires a pattern and input (stdin, –file, or –text).

output_pattern: bool

After interactive session, print the final pattern to stdout instead of matches. Useful for: eval $(rgx -P)

group: Option<String>

Print a specific capture group instead of the full match (use with –print). Accepts a group number (1, 2, …) or a named group.

count: bool

Print only the count of matches (use with –print).

json: bool

Output matches as JSON (use with –print).

color: ColorMode

Colorize match output: auto (default), always, or never (use with –print).

test: Option<Vec<String>>

Run test assertions from workspace file(s) and exit. Expects TOML files with [[tests]] sections.

rounded: bool

Use rounded border characters for panels.

vim: bool

Enable vim-style modal keybindings (Normal/Insert mode).

completions: Option<Shell>

Generate shell completions and exit.

Implementations

impl Cli

pub fn print_completions(shell: Shell)

Trait Implementations

impl Args for Cli

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 CommandFactory for Cli

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 Cli

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

Formats the value using the given formatter.

impl FromArgMatches for Cli

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 Cli

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.