Struct ArgumentError 

pub struct ArgumentError { /* private fields */ }

A structured argument validation failure.

The error owns its argument path and failure kind, allowing downstream error types to inspect or preserve it without parsing display text. Display escapes caller-provided fields into a single-line diagnostic; accessors and Debug continue to expose the original structured values.

Examples

use qubit_argument::{ArgumentError, ArgumentErrorKind};

let error = ArgumentError::new("value", ArgumentErrorKind::Missing);
assert_eq!(error.to_string(), "argument 'value' is missing");

#![deny(unused_must_use)]
use qubit_argument::{ArgumentError, ArgumentErrorKind};

ArgumentError::new("value", ArgumentErrorKind::Missing);

Implementations

impl ArgumentError

pub fn new(path: &str, kind: ArgumentErrorKind) -> Self

Creates an error from an argument path and structured failure kind.

path is copied only while constructing the error. The supplied kind is retained unchanged.

Parameters

• path: The path identifying the argument that failed validation.
• kind: The structured reason for the validation failure.

Returns

An error that owns the path and failure kind.

pub fn path(&self) -> &ArgumentPath

Returns the path of the argument that failed validation.

Returns

The path borrowed from this error.

pub fn kind(&self) -> &ArgumentErrorKind

Returns the structured validation failure kind.

Returns

The failure kind borrowed from this error.

pub fn with_path_prefix(self, prefix: &str) -> Self

Prepends a parent path to this validation error.

Parameters

• prefix: The parent path to place before the current error path.

Returns

This error with its path prefixed and its failure kind unchanged.

pub fn into_parts(self) -> (ArgumentPath, ArgumentErrorKind)

Consumes the error and returns its owned path and failure kind.

The first tuple element is the argument path and the second is the structured failure kind.

Returns

The owned argument path and structured failure kind, in that order.

Trait Implementations

impl Clone for ArgumentError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgumentError

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

Formats the value using the given formatter.

impl Display for ArgumentError

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

Formats a single-line diagnostic entirely from the structured fields.

impl Eq for ArgumentError

impl Error for ArgumentError

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.

impl PartialEq for ArgumentError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ArgumentError