Struct awint_core::InlAwi

pub struct InlAwi<const BW: usize, const LEN: usize> { /* fields omitted */ }

An arbitrary width integer with const generic bitwidth that can be stored inline on the stack like an array.

NOTE: Ideally, you could just type let _: InlAwi<100> = InlAwi<100>::zero(); if you wanted to specify and construct an InlAwi type with bitwidth 100. However, Rust’s lack of custom DST support and const generics limitations makes this currently impossible. The two const generic parameters of an InlAwi are part of a workaround for this. Typing out a let _: InlAwi<BW, LEN> = InlAwi<BW, LEN>::unstable_zero() should not be done directly because it is non-portable and relies on unstable internal details. Instead, you should use let _: inlawi_ty!(100) = inlawi_zero!(100); using macros from the awint_macros crate.

Implementations

impl<'a, const BW: usize, const LEN: usize> InlAwi<BW, LEN>

pub const fn const_as_ref(&'a self) -> &'a Bits

Returns a reference to self in the form of &Bits.

pub const fn const_as_mut(&'a mut self) -> &'a mut Bits

Returns a reference to self in the form of &mut Bits.

pub const fn nzbw(&self) -> NonZeroUsize

Returns the bitwidth of this InlAwi as a NonZeroUsize

pub const fn bw(&self) -> usize

Returns the bitwidth of this InlAwi as a usize

pub const fn len(&self) -> usize

Returns the exact number of usize digits needed to store all bits.

Trait Implementations

impl<const BW: usize, const LEN: usize> Binary for InlAwi<BW, LEN>

Forwards to the corresponding impl for Bits

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

Formats the value using the given formatter.

impl<const BW: usize, const LEN: usize> Clone for InlAwi<BW, LEN>

fn clone(&self) -> InlAwi<BW, LEN>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const BW: usize, const LEN: usize> Debug for InlAwi<BW, LEN>

Forwards to the corresponding impl for Bits

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

Formats the value using the given formatter.

impl<const BW: usize, const LEN: usize> Hash for InlAwi<BW, LEN>

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<const BW: usize, const LEN: usize> LowerHex for InlAwi<BW, LEN>

Forwards to the corresponding impl for Bits

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

Formats the value using the given formatter.

impl<const BW: usize, const LEN: usize> Octal for InlAwi<BW, LEN>

Forwards to the corresponding impl for Bits

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

Formats the value using the given formatter.

impl<const BW: usize, const LEN: usize> PartialEq<InlAwi<BW, LEN>> for InlAwi<BW, LEN>

If self and other have unmatching bit widths, false will be returned.

fn eq(&self, rhs: &Self) -> bool

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

#[must_use]

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

This method tests for !=.

impl<const BW: usize, const LEN: usize> UpperHex for InlAwi<BW, LEN>

Forwards to the corresponding impl for Bits

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

Formats the value using the given formatter.

impl<const BW: usize, const LEN: usize> Copy for InlAwi<BW, LEN>

impl<const BW: usize, const LEN: usize> Eq for InlAwi<BW, LEN>

If self and other have unmatching bit widths, false will be returned.

impl<const BW: usize, const LEN: usize> Send for InlAwi<BW, LEN>

InlAwi is safe to send between threads since it does not own aliasing memory and has no reference counting mechanism like Rc.

impl<const BW: usize, const LEN: usize> Sync for InlAwi<BW, LEN>

InlAwi is safe to share between threads since it does not own aliasing memory and has no mutable internal state like Cell or RefCell.