Struct mycelium_bitfield::pack::PackingUsize

source · [−]

pub struct PackingUsize(_);

Expand description

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

source

impl PackingUsize

source

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

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

source

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.

source

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

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

Panics

If value contains bits outside the range specified by packer.

source

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

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

source

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

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

source

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

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

source

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

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

source

pub const fn bits(self) -> usize

Finish packing bits into self, returning the wrapped value.

Trait Implementations

source

impl Binary for PackingUsize

source

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

Formats the value using the given formatter.

source

impl Clone for PackingUsize

source

fn clone(&self) -> PackingUsize

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for PackingUsize

source

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

Formats the value using the given formatter. Read more

source

impl From<PackingUsize> for usize

source

fn from(packing: PackingUsize) -> Self

Converts to this type from the input type.

source

impl From<usize> for PackingUsize

source

fn from(bits: usize) -> Self

Converts to this type from the input type.

source

impl LowerHex for PackingUsize

source

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

Formats the value using the given formatter.

source

impl PartialEq<PackingUsize> for PackingUsize

source

fn eq(&self, other: &PackingUsize) -> bool

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

source

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

This method tests for !=.

source

impl UpperHex for PackingUsize

source

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

Formats the value using the given formatter.

source

impl StructuralPartialEq for PackingUsize

Auto Trait Implementations

impl RefUnwindSafe for PackingUsize

impl Send for PackingUsize

impl Sync for PackingUsize

impl Unpin for PackingUsize

impl UnwindSafe for PackingUsize

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct mycelium_bitfield::pack::PackingUsize

Implementations

impl PackingUsize

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

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

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

Panics

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

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

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

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

pub const fn bits(self) -> usize

Trait Implementations

impl Binary for PackingUsize

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

impl Clone for PackingUsize

fn clone(&self) -> PackingUsize

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

impl Debug for PackingUsize

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

impl From<PackingUsize> for usize

fn from(packing: PackingUsize) -> Self

impl From<usize> for PackingUsize

fn from(bits: usize) -> Self

impl LowerHex for PackingUsize

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

impl PartialEq<PackingUsize> for PackingUsize

fn eq(&self, other: &PackingUsize) -> bool

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

impl UpperHex for PackingUsize

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

impl Copy for PackingUsize

impl Eq for PackingUsize

impl StructuralEq for PackingUsize

impl StructuralPartialEq for PackingUsize

Auto Trait Implementations

impl RefUnwindSafe for PackingUsize

impl Send for PackingUsize

impl Sync for PackingUsize

impl Unpin for PackingUsize

impl UnwindSafe for PackingUsize

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,