Struct Args

pub struct Args {
    pub path_to_query_file: Option<PathBuf>,
    pub query_text: Option<String>,
    pub capture_name: Option<String>,
    pub language: Option<SupportedLanguage>,
    pub filter: Option<String>,
    pub filter_arg: Option<String>,
    pub after_context: Option<usize>,
    pub before_context: Option<usize>,
    pub context: Option<usize>,
    pub only_matching: bool,
    /* private fields */
}

Fields

path_to_query_file: Option<PathBuf>

The path to a tree-sitter query file.

This conflicts with the –query option.

query_text: Option<String>

The source text of a tree-sitter query.

This conflicts with the –query-file option.

capture_name: Option<String>

The name of the tree-sitter query capture (without leading “@”) whose matching nodes will be output.

By default this is the “first” capture encountered in the query source text.

language: Option<SupportedLanguage>

The target language for matching.

By default all files corresponding to supported languages will be searched if the provided query can be successfully parsed for that language.

filter: Option<String>

The path to a dynamic library that can be used as a “filter plugin”.

Filter plugins allow for more fine-grained filtering of potentially matching tree-sitter AST nodes.

filter_arg: Option<String>

An arbitrary argument to be passed to the specified filter plugin.

It is up to the specific filter plugin whether it requires an argument to be passed (eg for self-configuration) and if so what format it expects that argument to be in.

after_context: Option<usize>

Show NUM lines after each match.

before_context: Option<usize>

Show NUM lines before each match.

context: Option<usize>

Show NUM lines before and after each match.

This is equivalent to providing both the -B/–before-context and -A/–after-context flags with the same value.

only_matching: bool

Print only the matched (non-empty) parts of a matching line, with each such part on a separate output line.

Trait Implementations

impl Args for 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 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 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 FromArgMatches for 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 for Args

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.