Struct BoundedInt32

pub struct BoundedInt32<const LOWER: i32, const UPPER: i32> {
    pub(crate) value: i32,
}

A 32-bit signed integer with a restricted range.

This type holds an i32 value such that LOWER <= value <= UPPER

Limitations

If you try to instantiate this type with LOWER > UPPER, you will get an uninhabitable type. It would be better if we could check that at compile time, and prevent such types from being named.

Fields

value: i32

Interior Value

Implementations

impl<const LOWER: i32, const UPPER: i32> BoundedInt32<LOWER, UPPER>

pub const LOWER: i32 = LOWER

Lower bound

pub const UPPER: i32 = UPPER

Upper bound

pub(crate) fn unchecked_new(value: i32) -> Self

Private constructor function for this type.

pub const fn lower(&self) -> i32

Return the lower bound value of this bounded i32.

This always return Self::LOWER.

pub const fn upper(&self) -> i32

Return the lower bound value of this bounded i32.

This always return Self::LOWER.

pub fn get(&self) -> i32

Return the underlying i32 value.

This value will always be between Self::LOWER and Self::UPPER, inclusive.

pub fn saturating_new(val: i32) -> Self

If val is within range, return a new BoundedInt32 wrapping it; otherwise, clamp it to the upper or lower bound as appropriate.

pub fn checked_new(val: i32) -> Result<Self, Error>

If val is an acceptable value inside the range for this type, return a new BoundedInt32. Otherwise return an error.

pub(crate) fn clamp(val: i32) -> i32

This private function clamps an input to the acceptable range.

pub fn saturating_from(val: i32) -> Self

Convert from the underlying type, clamping to the upper or lower bound if needed.

Panics

This function will panic if UPPER < LOWER.

pub fn saturating_from_str(s: &str) -> Result<Self, Error>

Convert from a string, clamping to the upper or lower bound if needed.

Limitations

If the input is a number that cannot be represented as an i32, then we return an error instead of clamping it.

Trait Implementations

impl<const LOWER: i32, const UPPER: i32> Clone for BoundedInt32<LOWER, UPPER>

fn clone(&self) -> BoundedInt32<LOWER, UPPER>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const LOWER: i32, const UPPER: i32> Debug for BoundedInt32<LOWER, UPPER>

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

Formats the value using the given formatter.

impl<const L: i32, const U: i32> Display for BoundedInt32<L, U>

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

Formats the value using the given formatter.

impl From<BoundedInt32<0, 1>> for bool

fn from(val: BoundedInt32<0, 1>) -> bool

Converts to this type from the input type.

impl From<BoundedInt32<0, 255>> for u8

fn from(val: BoundedInt32<0, 255>) -> u8

Converts to this type from the input type.

impl<const L: i32, const H: i32> From<BoundedInt32<L, H>> for u32

fn from(val: BoundedInt32<L, H>) -> u32

Converts to this type from the input type.

impl<const L: i32, const U: i32> From<BoundedInt32<L, U>> for f64

fn from(val: BoundedInt32<L, U>) -> f64

Converts to this type from the input type.

impl<const L: i32, const U: i32> From<BoundedInt32<L, U>> for i32

fn from(val: BoundedInt32<L, U>) -> i32

Converts to this type from the input type.

impl<const L: i32, const H: i32> FromStr for BoundedInt32<L, H>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<const LOWER: i32, const UPPER: i32> HasMemoryCostStructural for BoundedInt32<LOWER, UPPER>

fn indirect_memory_cost(&self, et: EnabledToken) -> usize

Memory cost of data stored out-of-line

impl<const LOWER: i32, const UPPER: i32> Hash for BoundedInt32<LOWER, UPPER>

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 LOWER: i32, const UPPER: i32> PartialEq for BoundedInt32<LOWER, UPPER>

fn eq(&self, other: &BoundedInt32<LOWER, UPPER>) -> 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 L: i32, const H: i32> TryFrom<BoundedInt32<L, H>> for u64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: BoundedInt32<L, H>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const L: i32, const H: i32> TryFrom<BoundedInt32<L, H>> for usize

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: BoundedInt32<L, H>) -> Result<Self, Self::Error>

Performs the conversion.

impl<const L: i32, const H: i32> TryFrom<i32> for BoundedInt32<L, H>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl<const LOWER: i32, const UPPER: i32> Copy for BoundedInt32<LOWER, UPPER>

impl<const LOWER: i32, const UPPER: i32> Eq for BoundedInt32<LOWER, UPPER>

impl<const LOWER: i32, const UPPER: i32> StructuralPartialEq for BoundedInt32<LOWER, UPPER>