Enum ArgumentErrorKind 

#[non_exhaustive]
pub enum ArgumentErrorKind {
    Missing,
    Blank,
    Empty,
    Length {
        actual: usize,
        constraint: LengthConstraint,
        metric: LengthMetric,
    },
    Comparison {
        actual: ArgumentValue,
        constraint: ComparisonConstraint,
    },
    Range {
        actual: ArgumentValue,
        constraint: RangeConstraint,
    },
    InvalidLengthConstraint {
        constraint: LengthConstraint,
        metric: LengthMetric,
    },
    InvalidRangeConstraint {
        constraint: RangeConstraint,
    },
    NotANumber,
    NotFinite {
        actual: ArgumentValue,
    },
    Index {
        index: usize,
        size: usize,
        role: IndexRole,
    },
    IndexRange {
        start: usize,
        end: usize,
        size: usize,
    },
    Bounds {
        offset: usize,
        length: usize,
        total_length: usize,
    },
    Pattern {
        pattern: String,
        expectation: PatternExpectation,
    },
    Custom {
        code: String,
        message: String,
    },
}

Identifies the validation rule that an argument failed.

Each variant stores only structured context needed to inspect and format the failure. Validated string contents are never captured implicitly.

#![deny(unused_must_use)]
use qubit_argument::ArgumentErrorKind;

ArgumentErrorKind::Missing;

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Missing

The required argument was absent.

Blank

The string argument contained no non-whitespace characters.

Empty

The collection argument was empty.

Length

The argument length did not satisfy a length constraint.

Fields

actual: usize

The observed length in the unit identified by metric.

constraint: LengthConstraint

The required length relationship.

metric: LengthMetric

The unit used to measure the observed and required lengths.

Comparison

A scalar argument did not satisfy a comparison constraint.

Fields

actual: ArgumentValue

The observed numeric or duration value.

constraint: ComparisonConstraint

The required comparison relationship.

Range

The numeric argument was outside a required range.

Fields

actual: ArgumentValue

The observed numeric value.

constraint: RangeConstraint

The required range.

InvalidLengthConstraint

The supplied length constraint was internally invalid.

Fields

constraint: LengthConstraint

The invalid length constraint.

metric: LengthMetric

The unit to which the invalid constraint would have applied.

InvalidRangeConstraint

The supplied numeric range was internally invalid.

Fields

constraint: RangeConstraint

The invalid numeric range.

NotANumber

The argument or numeric constraint contained a floating-point NaN value.

NotFinite

The floating-point argument was positive or negative infinity.

Fields

actual: ArgumentValue

The rejected infinite floating-point value.

Index

An element or position index was outside its valid domain.

Fields

index: usize

The rejected index.

size: usize

The collection size used for validation.

role: IndexRole

Whether the index identifies an element or a position.

IndexRange

A position range was invalid for a collection size.

Fields

start: usize

The inclusive start position.

end: usize

The exclusive end position.

size: usize

The collection size used for validation.

Bounds

An offset and length did not fit within a total length.

Fields

offset: usize

The rejected starting offset.

length: usize

The rejected span length.

total_length: usize

The available total length.

Pattern

A string did not satisfy a pattern expectation.

Fields

pattern: String

The pattern text used for validation.

expectation: PatternExpectation

Whether a match or non-match was required.

Custom

A caller-defined validation rule failed.

Fields

code: String

A machine-readable caller-defined code.

message: String

A human-readable caller-defined explanation.

Trait Implementations

impl Clone for ArgumentErrorKind

fn clone(&self) -> ArgumentErrorKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgumentErrorKind

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

Formats the value using the given formatter.

impl Eq for ArgumentErrorKind

impl PartialEq for ArgumentErrorKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ArgumentErrorKind