Struct bounded_integer::examples::BoundedStruct

pub struct BoundedStruct(_);

A bounded struct, implemented as a protected newtype.

This was generated from:

#[repr(i8)]
pub struct BoundedStruct { -8..8 }

Implementations

impl BoundedStruct

pub const MIN_VALUE: i8

The smallest value that this bounded integer can contain.

pub const MAX_VALUE: i8

The largest value that this bounded integer can contain.

pub const MIN: Self

The smallest value of the bounded integer.

pub const MAX: Self

The largest value of the bounded integer.

pub const RANGE: i8

The number of values the bounded integer can contain.

#[must_use]pub unsafe fn new_unchecked(n: i8) -> Self

Creates a bounded integer without checking the value.

Safety

The value must not be outside the valid range of values; it must not be less than MIN or greater than MAX.

#[must_use]pub fn in_range(n: i8) -> bool

Checks whether the given value is in the range of the bounded integer.

#[must_use]pub fn new(n: i8) -> Option<Self>

Creates a bounded integer if the given value is within the range [MIN, MAX].

#[must_use]pub fn new_saturating(n: i8) -> Self

Creates a bounded integer by setting the value to MIN or MAX if it is too low or too high respectively.

#[must_use]pub fn new_wrapping(n: i8) -> Self

Creates a bounded integer by using modulo arithmetic. Values in the range won't be changed but values outside will be wrapped around.

#[must_use]pub fn get(self) -> i8

Gets the value of the bounded integer as a primitive type.

#[must_use]pub fn abs(self) -> Self

Computes the absolute value of self, panicking if it is out of range.

#[must_use]pub fn pow(self, exp: u32) -> Self

Raises self to the power of exp, using exponentiation by squaring. Panics if it is out of range.

#[must_use]pub fn div_euclid(self, rhs: i8) -> Self

Calculates the quotient of Euclidean division of self by rhs. Panics if rhs is 0 or the result is out of range.

#[must_use]pub fn rem_euclid(self, rhs: i8) -> Self

Calculates the least nonnegative remainder of self (mod rhs). Panics if rhs is 0 or the result is out of range.

#[must_use]pub fn checked_add(self, rhs: i8) -> Option<Self>

Checked integer addition.

#[must_use]pub fn saturating_add(self, rhs: i8) -> Self

Saturing integer addition.

#[must_use]pub fn checked_sub(self, rhs: i8) -> Option<Self>

Checked integer subtraction.

#[must_use]pub fn saturating_sub(self, rhs: i8) -> Self

Saturing integer subtraction.

#[must_use]pub fn checked_mul(self, rhs: i8) -> Option<Self>

Checked integer multiplication.

#[must_use]pub fn saturating_mul(self, rhs: i8) -> Self

Saturing integer multiplication.

#[must_use]pub fn checked_div(self, rhs: i8) -> Option<Self>

Checked integer division.

#[must_use]pub fn checked_div_euclid(self, rhs: i8) -> Option<Self>

Checked Euclidean division.

#[must_use]pub fn checked_rem(self, rhs: i8) -> Option<Self>

Checked integer remainder.

#[must_use]pub fn checked_rem_euclid(self, rhs: i8) -> Option<Self>

Checked Euclidean remainder.

#[must_use]pub fn checked_neg(self) -> Option<Self>

Checked negation.

#[must_use]pub fn checked_abs(self) -> Option<Self>

Checked absolute value.

#[must_use]pub fn checked_pow(self, rhs: u32) -> Option<Self>

Checked exponentiation.

#[must_use]pub fn saturating_pow(self, rhs: u32) -> Self

Saturing exponentiation.

Trait Implementations

impl<'b> Add<&'b BoundedStruct> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the + operator.

fn add(self, rhs: &'b BoundedStruct) -> Self::Output

Performs the + operation.

impl<'b, 'a> Add<&'b BoundedStruct> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the + operator.

fn add(self, rhs: &'b BoundedStruct) -> Self::Output

Performs the + operation.

impl<'b> Add<&'b i8> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the + operator.

fn add(self, rhs: &'b i8) -> Self::Output

Performs the + operation.

impl<'b, 'a> Add<&'b i8> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the + operator.

fn add(self, rhs: &'b i8) -> Self::Output

Performs the + operation.

impl Add<BoundedStruct> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the + operator.

fn add(self, rhs: BoundedStruct) -> Self::Output

Performs the + operation.

impl<'a> Add<BoundedStruct> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the + operator.

fn add(self, rhs: BoundedStruct) -> Self::Output

Performs the + operation.

impl Add<i8> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the + operator.

fn add(self, rhs: i8) -> Self::Output

Performs the + operation.

impl<'a> Add<i8> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the + operator.

fn add(self, rhs: i8) -> Self::Output

Performs the + operation.

impl<'a> AddAssign<&'a BoundedStruct> for BoundedStruct

fn add_assign(&mut self, rhs: &'a BoundedStruct)

Performs the += operation.

impl<'a> AddAssign<&'a i8> for BoundedStruct

fn add_assign(&mut self, rhs: &'a i8)

Performs the += operation.

impl AddAssign<BoundedStruct> for BoundedStruct

fn add_assign(&mut self, rhs: BoundedStruct)

Performs the += operation.

impl AddAssign<i8> for BoundedStruct

fn add_assign(&mut self, rhs: i8)

Performs the += operation.

impl Binary for BoundedStruct

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

Formats the value using the given formatter.

impl Clone for BoundedStruct

fn clone(&self) -> BoundedStruct

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BoundedStruct

impl Debug for BoundedStruct

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

Formats the value using the given formatter.

impl Display for BoundedStruct

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

Formats the value using the given formatter.

impl<'b> Div<&'b BoundedStruct> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the / operator.

fn div(self, rhs: &'b BoundedStruct) -> Self::Output

Performs the / operation.

impl<'b, 'a> Div<&'b BoundedStruct> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the / operator.

fn div(self, rhs: &'b BoundedStruct) -> Self::Output

Performs the / operation.

impl<'b> Div<&'b i8> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the / operator.

fn div(self, rhs: &'b i8) -> Self::Output

Performs the / operation.

impl<'b, 'a> Div<&'b i8> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the / operator.

fn div(self, rhs: &'b i8) -> Self::Output

Performs the / operation.

impl Div<BoundedStruct> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the / operator.

fn div(self, rhs: BoundedStruct) -> Self::Output

Performs the / operation.

impl<'a> Div<BoundedStruct> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the / operator.

fn div(self, rhs: BoundedStruct) -> Self::Output

Performs the / operation.

impl Div<i8> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the / operator.

fn div(self, rhs: i8) -> Self::Output

Performs the / operation.

impl<'a> Div<i8> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the / operator.

fn div(self, rhs: i8) -> Self::Output

Performs the / operation.

impl<'a> DivAssign<&'a BoundedStruct> for BoundedStruct

fn div_assign(&mut self, rhs: &'a BoundedStruct)

Performs the /= operation.

impl<'a> DivAssign<&'a i8> for BoundedStruct

fn div_assign(&mut self, rhs: &'a i8)

Performs the /= operation.

impl DivAssign<BoundedStruct> for BoundedStruct

fn div_assign(&mut self, rhs: BoundedStruct)

Performs the /= operation.

impl DivAssign<i8> for BoundedStruct

fn div_assign(&mut self, rhs: i8)

Performs the /= operation.

impl Eq for BoundedStruct

impl Hash for BoundedStruct

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, 

Feeds a slice of this type into the given [Hasher].

impl LowerExp for BoundedStruct

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

Formats the value using the given formatter.

impl LowerHex for BoundedStruct

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

Formats the value using the given formatter.

impl<'b> Mul<&'b BoundedStruct> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the * operator.

fn mul(self, rhs: &'b BoundedStruct) -> Self::Output

Performs the * operation.

impl<'b, 'a> Mul<&'b BoundedStruct> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the * operator.

fn mul(self, rhs: &'b BoundedStruct) -> Self::Output

Performs the * operation.

impl<'b> Mul<&'b i8> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the * operator.

fn mul(self, rhs: &'b i8) -> Self::Output

Performs the * operation.

impl<'b, 'a> Mul<&'b i8> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the * operator.

fn mul(self, rhs: &'b i8) -> Self::Output

Performs the * operation.

impl Mul<BoundedStruct> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the * operator.

fn mul(self, rhs: BoundedStruct) -> Self::Output

Performs the * operation.

impl<'a> Mul<BoundedStruct> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the * operator.

fn mul(self, rhs: BoundedStruct) -> Self::Output

Performs the * operation.

impl Mul<i8> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the * operator.

fn mul(self, rhs: i8) -> Self::Output

Performs the * operation.

impl<'a> Mul<i8> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the * operator.

fn mul(self, rhs: i8) -> Self::Output

Performs the * operation.

impl<'a> MulAssign<&'a BoundedStruct> for BoundedStruct

fn mul_assign(&mut self, rhs: &'a BoundedStruct)

Performs the *= operation.

impl<'a> MulAssign<&'a i8> for BoundedStruct

fn mul_assign(&mut self, rhs: &'a i8)

Performs the *= operation.

impl MulAssign<BoundedStruct> for BoundedStruct

fn mul_assign(&mut self, rhs: BoundedStruct)

Performs the *= operation.

impl MulAssign<i8> for BoundedStruct

fn mul_assign(&mut self, rhs: i8)

Performs the *= operation.

impl Neg for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<'a> Neg for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Octal for BoundedStruct

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

Formats the value using the given formatter.

impl Ord for BoundedStruct

fn cmp(&self, other: &BoundedStruct) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<BoundedStruct> for BoundedStruct

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

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

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

This method tests for !=.

impl PartialOrd<BoundedStruct> for BoundedStruct

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'b> Rem<&'b BoundedStruct> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the % operator.

fn rem(self, rhs: &'b BoundedStruct) -> Self::Output

Performs the % operation.

impl<'b, 'a> Rem<&'b BoundedStruct> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the % operator.

fn rem(self, rhs: &'b BoundedStruct) -> Self::Output

Performs the % operation.

impl<'b> Rem<&'b i8> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the % operator.

fn rem(self, rhs: &'b i8) -> Self::Output

Performs the % operation.

impl<'b, 'a> Rem<&'b i8> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the % operator.

fn rem(self, rhs: &'b i8) -> Self::Output

Performs the % operation.

impl Rem<BoundedStruct> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the % operator.

fn rem(self, rhs: BoundedStruct) -> Self::Output

Performs the % operation.

impl<'a> Rem<BoundedStruct> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the % operator.

fn rem(self, rhs: BoundedStruct) -> Self::Output

Performs the % operation.

impl Rem<i8> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the % operator.

fn rem(self, rhs: i8) -> Self::Output

Performs the % operation.

impl<'a> Rem<i8> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the % operator.

fn rem(self, rhs: i8) -> Self::Output

Performs the % operation.

impl<'a> RemAssign<&'a BoundedStruct> for BoundedStruct

fn rem_assign(&mut self, rhs: &'a BoundedStruct)

Performs the %= operation.

impl<'a> RemAssign<&'a i8> for BoundedStruct

fn rem_assign(&mut self, rhs: &'a i8)

Performs the %= operation.

impl RemAssign<BoundedStruct> for BoundedStruct

fn rem_assign(&mut self, rhs: BoundedStruct)

Performs the %= operation.

impl RemAssign<i8> for BoundedStruct

fn rem_assign(&mut self, rhs: i8)

Performs the %= operation.

impl StructuralEq for BoundedStruct

impl StructuralPartialEq for BoundedStruct

impl<'b> Sub<&'b BoundedStruct> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the - operator.

fn sub(self, rhs: &'b BoundedStruct) -> Self::Output

Performs the - operation.

impl<'b, 'a> Sub<&'b BoundedStruct> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the - operator.

fn sub(self, rhs: &'b BoundedStruct) -> Self::Output

Performs the - operation.

impl<'b> Sub<&'b i8> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the - operator.

fn sub(self, rhs: &'b i8) -> Self::Output

Performs the - operation.

impl<'b, 'a> Sub<&'b i8> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the - operator.

fn sub(self, rhs: &'b i8) -> Self::Output

Performs the - operation.

impl Sub<BoundedStruct> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the - operator.

fn sub(self, rhs: BoundedStruct) -> Self::Output

Performs the - operation.

impl<'a> Sub<BoundedStruct> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the - operator.

fn sub(self, rhs: BoundedStruct) -> Self::Output

Performs the - operation.

impl Sub<i8> for BoundedStruct

type Output = BoundedStruct

The resulting type after applying the - operator.

fn sub(self, rhs: i8) -> Self::Output

Performs the - operation.

impl<'a> Sub<i8> for &'a BoundedStruct

type Output = BoundedStruct

The resulting type after applying the - operator.

fn sub(self, rhs: i8) -> Self::Output

Performs the - operation.

impl<'a> SubAssign<&'a BoundedStruct> for BoundedStruct

fn sub_assign(&mut self, rhs: &'a BoundedStruct)

Performs the -= operation.

impl<'a> SubAssign<&'a i8> for BoundedStruct

fn sub_assign(&mut self, rhs: &'a i8)

Performs the -= operation.

impl SubAssign<BoundedStruct> for BoundedStruct

fn sub_assign(&mut self, rhs: BoundedStruct)

Performs the -= operation.

impl SubAssign<i8> for BoundedStruct

fn sub_assign(&mut self, rhs: i8)

Performs the -= operation.

impl UpperExp for BoundedStruct

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

Formats the value using the given formatter.

impl UpperHex for BoundedStruct

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

Formats the value using the given formatter.