Struct ScanArgs 

pub struct ScanArgs {
    pub path: Option<PathBuf>,
    pub tags: Option<Vec<String>>,
    pub include: Option<Vec<String>>,
    pub exclude: Option<Vec<String>>,
    pub json: bool,
    pub flat: bool,
    pub depth: usize,
    pub follow_links: bool,
    pub hidden: bool,
    pub case_sensitive: bool,
    pub sort: SortOrder,
    pub group_by_tag: bool,
}

Arguments for the scan command

Fields

path: Option<PathBuf>

Directory or file to scan (defaults to current directory)

tags: Option<Vec<String>>

Tags to search for (comma-separated)

include: Option<Vec<String>>

File patterns to include (glob patterns, comma-separated)

exclude: Option<Vec<String>>

File patterns to exclude (glob patterns, comma-separated)

json: bool

Output results in JSON format

flat: bool

Output results in flat format (no tree structure)

depth: usize

Maximum depth to scan (0 = unlimited)

follow_links: bool

Follow symbolic links

hidden: bool

Include hidden files and directories

case_sensitive: bool

Case-sensitive tag matching

sort: SortOrder

Sort results by: file, tag, line

group_by_tag: bool

Group results by tag instead of by file

Trait Implementations

impl Args for ScanArgs

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 Clone for ScanArgs

fn clone(&self) -> ScanArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanArgs

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

Formats the value using the given formatter.

impl Default for ScanArgs

fn default() -> Self

Returns the “default value” for a type.

impl From<ScanArgs> for ListArgs

Convert ScanArgs to ListArgs for the list command

fn from(scan: ScanArgs) -> Self

Converts to this type from the input type.

impl FromArgMatches for ScanArgs

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.