Struct i31

pub struct i31(/* private fields */);

An unsigned integer which contains 31 bits

Implementations

impl i31

pub const MAX: i32 = 1_073_741_823i32

The largest value this type can hold

pub const MIN: i32 = -1_073_741_824i32

The smallest value this type can hold

pub const unsafe fn new_unchecked(value: i32) -> Self

Create a new $name from value

Safety

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

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

Create a new $name from value

Safety

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

pub const fn value(self) -> i32

Get the value stored in here, as a signed integer

Trait Implementations

impl Add for i31

type Output = i31

The resulting type after applying the + operator.

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

Performs the + operation.

impl BitAnd for i31

type Output = i31

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for i31

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitCount for i31

const COUNT: usize = 31usize

The number of bits associated with this type

impl BitOr for i31

type Output = i31

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for i31

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for i31

type Output = i31

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for i31

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl BitsFitIn<u32> for i31

fn fit(self) -> u32

Fits self into the target type

impl BitsFitIn<u33> for i31

fn fit(self) -> u33

Fits self into the target type

impl BitsFitIn<u34> for i31

fn fit(self) -> u34

Fits self into the target type

impl BitsFitIn<u35> for i31

fn fit(self) -> u35

Fits self into the target type

impl BitsFitIn<u36> for i31

fn fit(self) -> u36

Fits self into the target type

impl BitsFitIn<u37> for i31

fn fit(self) -> u37

Fits self into the target type

impl BitsFitIn<u38> for i31

fn fit(self) -> u38

Fits self into the target type

impl BitsFitIn<u39> for i31

fn fit(self) -> u39

Fits self into the target type

impl BitsFitIn<u40> for i31

fn fit(self) -> u40

Fits self into the target type

impl BitsFitIn<u41> for i31

fn fit(self) -> u41

Fits self into the target type

impl BitsFitIn<u42> for i31

fn fit(self) -> u42

Fits self into the target type

impl BitsFitIn<u43> for i31

fn fit(self) -> u43

Fits self into the target type

impl BitsFitIn<u44> for i31

fn fit(self) -> u44

Fits self into the target type

impl BitsFitIn<u45> for i31

fn fit(self) -> u45

Fits self into the target type

impl BitsFitIn<u46> for i31

fn fit(self) -> u46

Fits self into the target type

impl BitsFitIn<u47> for i31

fn fit(self) -> u47

Fits self into the target type

impl BitsFitIn<u48> for i31

fn fit(self) -> u48

Fits self into the target type

impl BitsFitIn<u49> for i31

fn fit(self) -> u49

Fits self into the target type

impl BitsFitIn<u50> for i31

fn fit(self) -> u50

Fits self into the target type

impl BitsFitIn<u51> for i31

fn fit(self) -> u51

Fits self into the target type

impl BitsFitIn<u52> for i31

fn fit(self) -> u52

Fits self into the target type

impl BitsFitIn<u53> for i31

fn fit(self) -> u53

Fits self into the target type

impl BitsFitIn<u54> for i31

fn fit(self) -> u54

Fits self into the target type

impl BitsFitIn<u55> for i31

fn fit(self) -> u55

Fits self into the target type

impl BitsFitIn<u56> for i31

fn fit(self) -> u56

Fits self into the target type

impl BitsFitIn<u57> for i31

fn fit(self) -> u57

Fits self into the target type

impl BitsFitIn<u58> for i31

fn fit(self) -> u58

Fits self into the target type

impl BitsFitIn<u59> for i31

fn fit(self) -> u59

Fits self into the target type

impl BitsFitIn<u60> for i31

fn fit(self) -> u60

Fits self into the target type

impl BitsFitIn<u61> for i31

fn fit(self) -> u61

Fits self into the target type

impl BitsFitIn<u62> for i31

fn fit(self) -> u62

Fits self into the target type

impl BitsFitIn<u63> for i31

fn fit(self) -> u63

Fits self into the target type

impl BitsFitIn<u64> for i31

fn fit(self) -> u64

Fits self into the target type

impl Bounded for i31

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 i31

fn clone(&self) -> i31

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for i31

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

Formats the value using the given formatter.

impl Default for i31

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for i31

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for i31

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

Formats the value using the given formatter.

impl Div for i31

type Output = i31

The resulting type after applying the / operator.

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

Performs the / operation.

impl FieldStorage for i31

type StoredType = u32

The type this field stores as

fn inner_raw(self) -> Self::StoredType

Get the raw representation of this value

impl FromStr for i31

type Err = <i31 as Num>::FromStrRadixErr

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 Hash for i31

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

type Output = i31

The resulting type after applying the * operator.

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

Performs the * operation.

impl Num for i31

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 i31

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) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl Ord for i31

fn cmp(&self, other: &Self) -> 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 PartialEq for i31

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

fn partial_cmp(&self, other: &Self) -> 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 Rem for i31

type Output = i31

The resulting type after applying the % operator.

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

Performs the % operation.

impl Serialize for i31

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 i31

type Output = i31

The resulting type after applying the << operator.

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

Performs the << operation.

impl ShlAssign<usize> for i31

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for i31

type Output = i31

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl ShrAssign<usize> for i31

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Sub for i31

type Output = i31

The resulting type after applying the - operator.

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

Performs the - operation.

impl<P> ValidCheck<P> for i31

const ALWAYS_VALID: bool = true

Set this to true if, at compile-time, we can tell that all bit representations which contain the appropriate number of bits are valid representations of this type

fn is_valid(_input: P) -> bool

Return whether or not the underlying bits of P are valid representation of this type

impl Zero for i31

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 i31

impl Eq for i31

impl StructuralPartialEq for i31