Skip to main content

ArgumentError

Struct ArgumentError 

Source
pub struct ArgumentError { /* private fields */ }
Expand description

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.

Implementations§

Source§

impl ArgumentError

Source

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.

Source

pub fn path(&self) -> &ArgumentPath

Returns the path of the argument that failed validation.

Source

pub fn kind(&self) -> &ArgumentErrorKind

Returns the structured validation failure kind.

Source

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.

Source

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.

Trait Implementations§

Source§

impl Clone for ArgumentError

Source§

fn clone(&self) -> ArgumentError

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ArgumentError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ArgumentError

Source§

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

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

Source§

impl Eq for ArgumentError

Source§

impl Error for ArgumentError

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl PartialEq for ArgumentError

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ArgumentError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.