Struct bit_struct::u31

pub struct u31(_);

Implementations

impl u31

pub const MAX: u32 = 2_147_483_647u32

pub const MIN: u32 = 0u32

pub unsafe fn new_unchecked(value: u32) -> Self

Create a new $name from value

Safety

• value must fit within the number of bits defined in the type

pub fn new(value: u32) -> Option<Self>

pub fn value(self) -> u32

Trait Implementations

impl Add<u31> for u31

type Output = u31

The resulting type after applying the + operator.

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

Performs the + operation.

impl BitAnd<u31> for u31

type Output = u31

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign<u31> for u31

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitCount for u31

const COUNT: usize = 31usize

impl BitOr<u31> for u31

type Output = u31

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign<u31> for u31

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<u31> for u31

type Output = u31

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<u31> for u31

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Bounded for u31

fn min_value() -> Self

Returns the smallest finite number this type can represent

fn max_value() -> Self

Returns the largest finite number this type can represent

impl Clone for u31

fn clone(&self) -> u31

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for u31

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

Formats the value using the given formatter.

impl Default for u31

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for u31

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for u31

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

Formats the value using the given formatter.

impl Div<u31> for u31

type Output = u31

The resulting type after applying the / operator.

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

Performs the / operation.

impl Hash for u31

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 Mul<u31> for u31

type Output = u31

The resulting type after applying the * operator.

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

Performs the * operation.

impl Num for u31

type FromStrRadixErr = ()

fn from_str_radix(str: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl One for u31

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> boolwhere
    Self: PartialEq<Self>,

Returns true if self is equal to the multiplicative identity.

impl Ord for u31

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<u31> for u31

fn eq(&self, other: &u31) -> 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 PartialOrd<u31> for u31

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

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

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

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

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

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

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

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

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

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

impl Rem<u31> for u31

type Output = u31

The resulting type after applying the % operator.

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

Performs the % operation.

impl Serialize for u31

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl Shl<usize> for u31

type Output = u31

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Self::Output

Performs the << operation.

impl ShlAssign<usize> for u31

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for u31

type Output = u31

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation.

impl ShrAssign<usize> for u31

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Sub<u31> for u31

type Output = u31

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P> ValidCheck<P> for u31

const ALWAYS_VALID: bool = true

fn is_valid(_input: P) -> bool

impl Zero for u31

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Copy for u31

impl Eq for u31

impl StructuralEq for u31

impl StructuralPartialEq for u31