Struct mycelium_bitfield::pack::Pair128

source ·
pub struct Pair128<T = u128> { /* private fields */ }
Expand description

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

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

Implementations§

source§

impl Pair128

source

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

Returns the “source” member of the packing pair.

source

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

Returns the “destination” member of the packing pair.

source

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

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

source

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

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

source

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§

source§

impl<T> Binary for Pair128<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Clone for Pair128<T>

source§

fn clone(&self) -> Self

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<T> Debug for Pair128<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> LowerHex for Pair128<T>

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn eq(&self, other: &&Pair128<B>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

fn eq(&self, other: &Pair128<B>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<A, B> PartialEq<Pair128<B>> for Pair128<A>

source§

fn eq(&self, other: &Pair128<B>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T> UpperHex for Pair128<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Copy for Pair128<T>

source§

impl<T> Eq for Pair128<T>

Auto Trait Implementations§

§

impl<T> Freeze for Pair128<T>

§

impl<T> RefUnwindSafe for Pair128<T>

§

impl<T> Send for Pair128<T>

§

impl<T> Sync for Pair128<T>

§

impl<T> Unpin for Pair128<T>

§

impl<T> UnwindSafe for Pair128<T>

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.