Struct BoundedInt16 

pub struct BoundedInt16<const MIN: i16, const MAX: i16> { /* private fields */ }

Bounded type (inclusive) that holds a value that is MIN <= value <= MAX

Has the same representation as the primitive type.

Safety

Creating an instance with MIN > MAX is undefined behavior.

Implementations

impl<const MIN: i16, const MAX: i16> BoundedInt16<MIN, MAX>

pub const MAX: i16 = MAX

Upper bound.

pub const MAX_PACKED: Self

Upper bound, represented as the bounded type.

pub const MIN: i16 = MIN

Lower bound.

pub const MIN_PACKED: Self

Lower bound, represented as the bounded type.

pub const fn min(&self) -> i16

Returns Self::MIN.

pub const fn max(&self) -> i16

Returns Self::MAX.

pub fn new<N: Into<i16> + PartialOrd<i16> + Ord>( value: N, ) -> Result<Self, Error>

Create a new value of the type.

Returns the error if the provided value was outside of the defined bounds.

pub unsafe fn new_unchecked<N: Into<i16>>(value: N) -> Self

Create a new value of the type without any checks.

Safety

User is responsible for providing the value that is already between the defined bounds. Creating a value outside of the defined bounds is undefined behavior.

pub fn new_clamped<N: Into<i16> + PartialOrd<i16> + Ord>(value: N) -> Self

Create a new value of the type.

If value is within range, returns a new instance; otherwise, clamps it to the upper or lower bound.

pub fn get(self) -> i16

Returns the underlying value.

This value is guaranteed to be between Self::MIN and Self::MAX.

pub const fn get_const(&self) -> i16

const-compatible Self::get.

pub fn is_in_bounds(n: &i16) -> bool

Check if abstract value is within bounds.

pub fn clamp(n: i16) -> i16

Clamp the provided n between the Self::MIN and Self::MAX.

pub fn checked_add<Rhs: Into<i16>>(self, rhs: Rhs) -> Option<Self>

Checked integer addition. Computes self + rhs, returning None if either bound overflow or integer overflow occurred.

pub unsafe fn unchecked_add<Rhs: Into<i16>>(self, rhs: Rhs) -> Self

Unchecked integer addition. Computes self + rhs, assuming overflow cannot occur.

Safety

This results in undefined behavior if the result overflows the primitive type’s bounds or the [MIN, MAX] bounds of this type.

pub fn checked_sub<Rhs: Into<i16>>(self, rhs: Rhs) -> Option<Self>

Checked integer subtraction. Computes self - rhs, returning None if either bound overflow or integer overflow occurred.

pub unsafe fn unchecked_sub<Rhs: Into<i16>>(self, rhs: Rhs) -> Self

Unchecked integer subtraction. Computes self - rhs, assuming overflow cannot occur.

Safety

This results in undefined behavior if the result overflows the primitive type’s bounds or the [MIN, MAX] bounds of this type.

pub fn checked_mul<Rhs: Into<i16>>(self, rhs: Rhs) -> Option<Self>

Checked integer multiplication. Computes self * rhs, returning None if either bound overflow or integer overflow occurred.

pub unsafe fn unchecked_mul<Rhs: Into<i16>>(self, rhs: Rhs) -> Self

Unchecked integer multiplication. Computes self * rhs, assuming overflow cannot occur.

Safety

This results in undefined behavior if the result overflows the primitive type’s bounds or the [MIN, MAX] bounds of this type.

pub fn checked_div<Rhs: Into<i16>>(self, rhs: Rhs) -> Option<Self>

Checked integer division. Computes self / rhs, returning None if either bound overflow or integer overflow occurred.

pub fn checked_rem<Rhs: Into<i16>>(self, rhs: Rhs) -> Option<Self>

Checked integer remainder. Computes self % rhs, returning None if either bound overflow or integer overflow occurred.

pub fn checked_neg(self) -> Option<Self>

Checked negation. Computes -self, returning None if bound overflow or self == inner_num_repr::MIN occurred.

pub fn checked_pow(self, exp: u32) -> Option<Self>

Checked integer exponentiation. Computes self.pow(), returning None if bound overflow or self == inner_num_repr::MIN occurred.

Trait Implementations

impl<const MIN: i16, const MAX: i16> Clone for BoundedInt16<MIN, MAX>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MIN: i16, const MAX: i16> Copy for BoundedInt16<MIN, MAX>

impl<const MIN: i16, const MAX: i16> Debug for BoundedInt16<MIN, MAX>

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

Example of the string representation:

5 ∈ [1, 10]

impl<const MIN: i16, const MAX: i16> Display for BoundedInt16<MIN, MAX>

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

Uses the formatter of the inner_num_repr.

impl<const MIN: i16, const MAX: i16> Eq for BoundedInt16<MIN, MAX>

impl From<BoundedInt16<{ i8::MIN as _ }, { i8::MAX as _ }>> for i8

fn from(value: BoundedInt16<-128, 127>) -> Self

Converts to this type from the input type.

impl From<BoundedInt16<{ u8::MIN as _ }, { u8::MAX as _ }>> for u8

fn from(value: BoundedInt16<0, 255>) -> Self

Converts to this type from the input type.

impl<const MIN: i16, const MAX: i16> Hash for BoundedInt16<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: i16, const MAX: i16> Into<i16> for BoundedInt16<MIN, MAX>

fn into(self) -> i16

Converts this type into the (usually inferred) input type.

impl<const MIN: i16, const MAX: i16> Ord for BoundedInt16<MIN, MAX>

fn cmp(&self, other: &BoundedInt16<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: i16, const MAX: i16> PartialEq for BoundedInt16<MIN, MAX>

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

Equality operator ==.

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

Inequality operator !=.

impl<const MIN: i16, const MAX: i16> PartialEq<i16> for BoundedInt16<MIN, MAX>

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

Equality operator ==.

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

Inequality operator !=.

impl<const MIN: i16, const MAX: i16> PartialOrd for BoundedInt16<MIN, MAX>

fn partial_cmp(&self, other: &BoundedInt16<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: i16, const MAX: i16> PartialOrd<i16> for BoundedInt16<MIN, MAX>

fn partial_cmp(&self, other: &i16) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<const MIN: i16, const MAX: i16> StructuralPartialEq for BoundedInt16<MIN, MAX>

impl<const MIN: i16, const MAX: i16> TryFrom<i16> for BoundedInt16<MIN, MAX>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<Self, Self::Error>

Performs the conversion.