Struct ContextArgs 

pub struct ContextArgs {
    pub context: Option<ContextMode>,
    pub after_context: Option<usize>,
    pub before_context: Option<usize>,
}

Shared context arguments for commands that retrieve content.

This group provides grep-style context line options for commands that return content with surrounding lines (search, get, find, etc.).

Usage

Flatten into command structs:

#[derive(Args)]
struct GetArgs {
    #[command(flatten)]
    context: ContextArgs,
    // ... other args
}

Then resolve to a ContextMode:

let mode = args.context.resolve();

Fields

context: Option<ContextMode>

Lines of context before and after each match (grep-style).

Use a number for symmetric context, or “all” for full section.

Examples: -C 5 # 5 lines before and after –context 10 # 10 lines before and after –context all # Full section

after_context: Option<usize>

Lines of context after each match.

Can be combined with -B for asymmetric context.

Examples: -A 5 # 5 lines after match –after-context 3 # 3 lines after match

before_context: Option<usize>

Lines of context before each match.

Can be combined with -A for asymmetric context.

Examples: -B 5 # 5 lines before match –before-context 3 # 3 lines before match

Implementations

impl ContextArgs

pub const fn symmetric(lines: usize) -> Self

Create context args with symmetric context.

pub const fn all() -> Self

Create context args for full section expansion.

pub fn resolve(&self) -> Option<ContextMode>

Resolve the context arguments into a single ContextMode.

Implements grep-style merging logic:

• -C provides symmetric context
• -A and -B can be combined for asymmetric context
• If multiple flags are provided, takes maximum value for each direction

pub const fn has_context(&self) -> bool

Check if any context is requested.

Trait Implementations

impl Args for ContextArgs

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 ContextArgs

fn clone(&self) -> ContextArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContextArgs

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

Formats the value using the given formatter.

impl Default for ContextArgs

fn default() -> ContextArgs

Returns the “default value” for a type.

impl FromArgMatches for ContextArgs

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 PartialEq for ContextArgs

fn eq(&self, other: &ContextArgs) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ContextArgs

impl StructuralPartialEq for ContextArgs