Struct ValidationError 

pub struct ValidationError { /* private fields */ }

A command-wide validation or finalization failure.

Return this from a #[usage(validate_with = ...)] hook or from the TryFrom implementation named by #[usage(try_into = ...)]. The derive turns it into the same Error::InvalidValue diagnostic used by field conversion, so callers keep one parse error type.

Implementations

impl ValidationError

pub fn field(name: &'static str) -> ValidationError

Start an error attributed to a flag, positional, or command name.

pub fn value(self, value: impl Into<String>) -> ValidationError

Record the value that failed the command-wide invariant.

pub fn reason(self, reason: impl Into<String>) -> ValidationError

Explain the invariant that the value did not satisfy.

pub fn into_parse_error<'v>(self) -> Error<'static, 'v>

Convert this application-level failure into the parser’s diagnostic.

Trait Implementations

impl Clone for ValidationError

fn clone(&self) -> ValidationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationError

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

Formats the value using the given formatter.

impl Eq for ValidationError

impl PartialEq for ValidationError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ValidationError