Struct ArgsErrorWithInput 

pub struct ArgsErrorWithInput { /* private fields */ }

An args parsing error, with input info, so that it can be formatted nicely

Implementations

impl ArgsErrorWithInput

pub fn is_help_request(&self) -> bool

Returns true if this is a help request (not a real error)

Examples found in repository

examples/demo_errors.rs (line 100)

fn main() {
    let scenarios = [
        ("Top-level help", vec!["--help"]),
        ("Missing required subcommand", vec![]),
        ("Unknown subcommand", vec!["notacommand"]),
        ("Subcommand help", vec!["clone", "--help"]),
        ("Nested subcommand help", vec!["remote", "add", "--help"]),
    ];

    for (description, args_vec) in &scenarios {
        println!("\n{}", "=".repeat(80));
        println!("SCENARIO: {}", description);
        println!("Args: {:?}", args_vec);
        println!("{}", "=".repeat(80));

        let result = args::from_slice::<GitArgs>(args_vec);
        match result {
            Ok(_) => println!("✓ Successfully parsed arguments"),
            Err(e) => {
                let is_help = e.is_help_request();
                println!(
                    "\n{} {}",
                    if is_help {
                        "ℹ️  Help requested"
                    } else {
                        "❌ Error"
                    },
                    if is_help {
                        "(exit code: 0)"
                    } else {
                        "(exit code: 1)"
                    }
                );
                println!("\n{:?}\n", Report::new(e));
            }
        }
    }

    println!("\n{}", "=".repeat(80));
    println!("Summary:");
    println!("  • Help requests exit with code 0 and show colored help");
    println!("  • Errors exit with code 1 and show diagnostic with suggestions");
    println!("  • Subcommand help works with: <subcommand> --help");
    println!("{}", "=".repeat(80));
}

pub fn help_text(&self) -> Option<&str>

If this is a help request, returns the help text

Trait Implementations

impl Debug for ArgsErrorWithInput

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

Formats the value using the given formatter.

impl Diagnostic for ArgsErrorWithInput

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for ArgsErrorWithInput

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

Formats the value using the given formatter.

impl Error for ArgsErrorWithInput

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.