Struct stm32wlxx_hal::subghz::ValueError

pub struct ValueError<T> { /* private fields */ }

Error for a value that is out-of-bounds.

Used by Timeout::from_duration.

Implementations

impl<T> ValueError<T>

pub const fn too_high(value: T, limit: T) -> ValueError<T>

Create a new ValueError for a value that exceeded an upper bound.

Unfortunately panic is not available in const fn, so there are no guarantees on the value being greater than the limit.

Example

use stm32wlxx_hal::subghz::ValueError;

const ERROR: ValueError<u8> = ValueError::too_high(101u8, 100u8);
assert!(ERROR.over());
assert!(!ERROR.under());

pub const fn too_low(value: T, limit: T) -> ValueError<T>

Create a new ValueError for a value that exceeded a lower bound.

Unfortunately panic is not available in const fn, so there are no guarantees on the value being less than the limit.

Example

use stm32wlxx_hal::subghz::ValueError;

const ERROR: ValueError<u8> = ValueError::too_low(200u8, 201u8);
assert!(ERROR.under());
assert!(!ERROR.over());

pub const fn value(&self) -> &T

Get the value that caused the error.

Example

use stm32wlxx_hal::subghz::ValueError;

const ERROR: ValueError<u8> = ValueError::too_high(101u8, 100u8);
assert_eq!(ERROR.value(), &101u8);

pub const fn limit(&self) -> &T

Get the limit for the value.

Example

use stm32wlxx_hal::subghz::ValueError;

const ERROR: ValueError<u8> = ValueError::too_high(101u8, 100u8);
assert_eq!(ERROR.limit(), &100u8);

pub const fn over(&self) -> bool

Returns true if the value was over the limit.

Example

use stm32wlxx_hal::subghz::ValueError;

const ERROR: ValueError<u8> = ValueError::too_high(101u8, 100u8);
assert!(ERROR.over());
assert!(!ERROR.under());

pub const fn under(&self) -> bool

Returns true if the value was under the limit.

Example

use stm32wlxx_hal::subghz::ValueError;

const ERROR: ValueError<u8> = ValueError::too_low(200u8, 201u8);
assert!(ERROR.under());
assert!(!ERROR.over());

Trait Implementations

impl<T: Clone> Clone for ValueError<T>

fn clone(&self) -> ValueError<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ValueError<T>

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

Formats the value using the given formatter.

impl<T> Display for ValueError<T>where T: Display,

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for ValueError<T>

fn eq(&self, other: &ValueError<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Copy> Copy for ValueError<T>

impl<T: Eq> Eq for ValueError<T>

impl<T> StructuralEq for ValueError<T>

impl<T> StructuralPartialEq for ValueError<T>