Struct mycelium_bitfield::pack::PairUsize

pub struct PairUsize<T = usize> { /* private fields */ }

A pair of PackUsizes, allowing a bit range to be unpacked from one offset in a usize value, and packed into a different offset in a different value.

See the module-level documentation for details on using packing specs.

Implementations

impl PairUsize

pub const fn src(&self) -> &PackUsize

Returns the “source” member of the packing pair.

pub const fn dst(&self) -> &PackUsize

Returns the “destination” member of the packing pair.

pub const fn pack_from_src(&self, src: usize, dst: usize) -> usize

Pack bits from the source location in src into the destination location in dst.

pub const fn pack_from_dst(&self, src: usize, dst: usize) -> usize

Pack bits from the destination location in dst into the source location in src.

pub fn assert_valid(&self)

Asserts that this packing pair is valid.

Because assertions cannot be made in const fn, this performs validating assertions that would ideally be made when constructing a new instance of this type. When packing specs are declared as consts, this method can be called in a unit test to ensure that the spec is valid.

Trait Implementations

impl<T> Binary for PairUsize<T>

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

Formats the value using the given formatter.

impl<T> Clone for PairUsize<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for PairUsize<T>

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

Formats the value using the given formatter.

impl<T> LowerHex for PairUsize<T>

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

Formats the value using the given formatter.

impl<A, B> PartialEq<&PairUsize<B>> for PairUsize<A>

fn eq(&self, other: &&PairUsize<B>) -> 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<A, B> PartialEq<PairUsize<B>> for &PairUsize<A>

fn eq(&self, other: &PairUsize<B>) -> 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<A, B> PartialEq<PairUsize<B>> for PairUsize<A>

fn eq(&self, other: &PairUsize<B>) -> 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<T> UpperHex for PairUsize<T>

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

Formats the value using the given formatter.

impl<T> Copy for PairUsize<T>

impl<T> Eq for PairUsize<T>