Struct U22

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

A 22-bit unsigned integer.

Implementations

impl U22

pub const MAX: u32 = 4_194_303u32

The largest value that can be expressed by this type

pub const fn from_u32(n: u32) -> Result<Self, U22FromU32Error>

Creates a new 22-bit integer from the given 32-bit integer if it is small enough to fit.

Examples

assert_eq!(U22::from_u32(42).map(U22::as_u32), Ok(42));
assert_eq!(U22::from_u32(U22::MAX).map(U22::as_u32), Ok(U22::MAX));
assert_eq!(U22::from_u32(U22::MAX + 1), Err(U22FromU32Error(U22::MAX + 1)));

pub const unsafe fn from_u32_unchecked(n: u32) -> Self

Creates a new 22-bit integer from the given 32-bit integer.

Safety

The provided integer must be no greater than U22::MAX.

Examples

let u22 = unsafe { U22::from_u32_unchecked(42) };
assert_eq!(u22.as_u32(), 42);

pub const fn as_u32(self) -> u32

Gets the 22-bit integer as a 32-bit integer.

Examples

let u22 = U22::from_u32(42).unwrap();
assert_eq!(u22.as_ref(), &42);

Methods from Deref<Target = u32>

pub const MIN: u32 = 0u32

pub const MAX: u32 = 4_294_967_295u32

pub const BITS: u32 = 32u32

Trait Implementations

impl AsRef<u32> for U22

fn as_ref(&self) -> &u32

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<u32> for U22

fn borrow(&self) -> &u32

Immutably borrows from an owned value.

impl Clone for U22

fn clone(&self) -> U22

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for U22

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

Formats the value using the given formatter.

impl Default for U22

fn default() -> U22

Returns the “default value” for a type.

impl Deref for U22

type Target = u32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for U22

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

Formats the value using the given formatter.

impl From<U22> for PackedChar

fn from(u22: U22) -> Self

Converts to this type from the input type.

impl From<U22> for u32

fn from(u22: U22) -> Self

Converts to this type from the input type.

impl Hash for U22

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 Ord for U22

fn cmp(&self, other: &U22) -> 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 U22

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

fn partial_cmp(&self, other: &U22) -> 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 TryFrom<u32> for U22

type Error = U22FromU32Error

The type returned in the event of a conversion error.

fn try_from(n: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for U22

impl Eq for U22

impl StructuralPartialEq for U22