Struct mycelium_bitfield::pack::PackingUsize

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

Wraps a usize to add methods for packing bit ranges specified by PackUsize.

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

Implementations

impl PackingUsize

pub const fn new(bits: usize) -> Self

Wrap a usize to add methods for packing bit ranges using PackUsize.

pub const fn pack_truncating(self, value: usize, packer: &PackUsize) -> Self

Pack bits from value into self, using the range specified by packer.

Any bits in value outside the range specified by packer are ignored.

pub const fn pack_from_src(self, value: usize, pair: &PairUsize) -> Self

Pack bits from src into self, using the packing pair specified by pair, with self serving as the “destination” member of the pair, and src serving as the “source” member of the pair.

pub const fn pack_from_dst(self, value: usize, pair: &PairUsize) -> Self

Pack bits from dst into self, using the packing pair specified by pair, with self serving as the “siyrce” member of the pair, and dst serving as the “destination” member of the pair.

pub fn pack<T: FromBits<usize>, F>( self, value: T, packer: &PackUsize<T, F>, ) -> Self

Pack bits from value into self, using the range specified by packer.

Panics

If value contains bits outside the range specified by packer.

pub const fn set_all<T, F>(self, packer: &PackUsize<T, F>) -> Self

Set all bits in the range specified by packer to 1 in self.

pub const fn unset_all<T, F>(self, packer: &PackUsize<T, F>) -> Self

Set all bits in the range specified by packer to 0 in self.

pub const fn contains_any<T, F>(self, packer: &PackUsize<T, F>) -> bool

Returns true if any bits specified by packer are set in self.

pub const fn contains_all<T, F>(self, packer: &PackUsize<T, F>) -> bool

Returns true if any bits specified by packer are set in self.

pub const fn bits(self) -> usize

Finish packing bits into self, returning the wrapped value.

Trait Implementations

impl Binary for PackingUsize

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

Formats the value using the given formatter.

impl Clone for PackingUsize

fn clone(&self) -> PackingUsize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackingUsize

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

Formats the value using the given formatter.

impl From<PackingUsize> for usize

fn from(packing: PackingUsize) -> Self

Converts to this type from the input type.

impl From<usize> for PackingUsize

fn from(bits: usize) -> Self

Converts to this type from the input type.

impl LowerHex for PackingUsize

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

Formats the value using the given formatter.

impl PartialEq for PackingUsize

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

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

Formats the value using the given formatter.

impl Copy for PackingUsize

impl Eq for PackingUsize

impl StructuralPartialEq for PackingUsize