Enum ConstrainedU16Error 

pub enum ConstrainedU16Error<const MIN: u16, const MAX: u16> {
    Lower(MinU16Error<MIN>),
    Greater(MaxU16Error<MAX>),
}

An error that indicates which range bound was violated by a u16 value.

This error can be returned from fallible APIs for ConstrainedU16.

The Lower variant indicates that the value is lower than ConstrainedU16::MIN.

The Greater variant indicates that the value is greater than ConstrainedU16::MAX.

If this crate’s std feature is enabled, this error implements the standard library’s Error trait.

Examples

Variants can be pattern matched to identify which bound was violated.

use constrained_int::u16::{ConstrainedU16, ConstrainedU16Error};

type Constrained = ConstrainedU16<1, 254>;

// First is below lower bound, second is above upper bound.
let results = [Constrained::new(0), Constrained::new(255)];
for result in results {
    match result {
        Err(ConstrainedU16Error::Lower(_)) => /*...*/ (),
        Err(ConstrainedU16Error::Greater(_)) => /*...*/ (),
        _ => unreachable!(),
    }
}

Associated constants are guarded against parameters that violate the MAX > MIN condition.

use constrained_int::u16::{ConstrainedU16, ConstrainedU16Error};

// MIN greater or equal to MAX is invalid.
type InvalidRange = ConstrainedU16<254, 1>;

// None of these will compile for InvalidRange.
let min = InvalidRange::MIN;
let max = InvalidRange::MAX;

Variants

Lower(MinU16Error<MIN>)

Indicates that the provided value is lower than ConstrainedU16::MIN.

Greater(MaxU16Error<MAX>)

Indicates that the provided value is greater than ConstrainedU16::MAX.

Implementations

impl<const MIN: u16, const MAX: u16> ConstrainedU16Error<MIN, MAX>

where Guard<{ _ }>: Protect,

pub const MIN: u16 = MIN

The minimum inclusive bound enforced by the range.

It’s assigned the MIN parameter value. Always satisfies the condition: MIN < MAX.

Example

use constrained_int::u16::ConstrainedU16Error;

type ConstrainedError = ConstrainedU16Error<1, 254>;

assert_eq!(ConstrainedError::MIN,1);

pub const MAX: u16 = MAX

The maximum inclusive bound enforced by the range.

It’s assigned the MAX parameter value. Always satisfies the condition: MAX > MIN.

Example

use constrained_int::u16::ConstrainedU16Error;

type ConstrainedError = ConstrainedU16Error<1, 254>;

assert_eq!(ConstrainedError::MAX,254);

Trait Implementations

impl<const MIN: u16, const MAX: u16> Clone for ConstrainedU16Error<MIN, MAX>

fn clone(&self) -> ConstrainedU16Error<MIN, MAX>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MIN: u16, const MAX: u16> Debug for ConstrainedU16Error<MIN, MAX>

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

Formats the value using the given formatter.

impl<const MIN: u16, const MAX: u16> Display for ConstrainedU16Error<MIN, MAX>

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

Formats the value using the given formatter.

impl<const MIN: u16, const MAX: u16> Error for ConstrainedU16Error<MIN, MAX>

Available on crate feature std only.

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<const MIN: u16, const MAX: u16> From<MaxU16Error<MAX>> for ConstrainedU16Error<MIN, MAX>

fn from(err: MaxU16Error<MAX>) -> Self

Converts to this type from the input type.

impl<const MIN: u16, const MAX: u16> From<MinU16Error<MIN>> for ConstrainedU16Error<MIN, MAX>

fn from(err: MinU16Error<MIN>) -> Self

Converts to this type from the input type.

impl<const MIN: u16, const MAX: u16> Hash for ConstrainedU16Error<MIN, MAX>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const MIN: u16, const MAX: u16> Ord for ConstrainedU16Error<MIN, MAX>

fn cmp(&self, other: &ConstrainedU16Error<MIN, MAX>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const MIN: u16, const MAX: u16> PartialEq for ConstrainedU16Error<MIN, MAX>

fn eq(&self, other: &ConstrainedU16Error<MIN, MAX>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const MIN: u16, const MAX: u16> PartialOrd for ConstrainedU16Error<MIN, MAX>

fn partial_cmp(&self, other: &ConstrainedU16Error<MIN, MAX>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const MIN: u16, const MAX: u16> Copy for ConstrainedU16Error<MIN, MAX>

impl<const MIN: u16, const MAX: u16> Eq for ConstrainedU16Error<MIN, MAX>

impl<const MIN: u16, const MAX: u16> StructuralPartialEq for ConstrainedU16Error<MIN, MAX>