Trait Bits 

pub trait Bits: Copy {
    const BITS: u32;

    // Required methods
    fn into_bits(self) -> u128;
    fn from_bits(raw: u128) -> Self;
}

A value that occupies a fixed number of bits within a bitfield.

The contract: into_bits yields the value in the low BITS bits of a u128 (higher bits zero), and from_bits reconstructs from the low BITS bits of its argument (higher bits ignored). Implementations must round-trip: T::from_bits(x.into_bits()) == x for every representable x.

bool, the primitive unsigned integers, and the UInt types implement it out of the box; #[bitfield] and #[derive(BitEnum)] generate impls so those types nest as fields too.

use bnb::Bits;

assert_eq!(<u8 as Bits>::BITS, 8);
assert_eq!(0xABu8.into_bits(), 0xAB);
assert_eq!(u8::from_bits(0x1FF), 0xFF); // from_bits truncates to the width
assert!(!bool::from_bits(0b10)); // only the low bit is read

Required Associated Constants

const BITS: u32

The number of bits this value occupies on the wire.

Required Methods

fn into_bits(self) -> u128

This value as the low BITS bits of a u128.

fn from_bits(raw: u128) -> Self

Reconstruct from the low BITS bits of raw; any higher bits are ignored.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Bits for bool

const BITS: u32 = 1

fn into_bits(self) -> u128

fn from_bits(raw: u128) -> Self

impl Bits for u8

const BITS: u32 = u8::BITS

fn into_bits(self) -> u128

fn from_bits(raw: u128) -> Self

impl Bits for u16

const BITS: u32 = u16::BITS

fn into_bits(self) -> u128

fn from_bits(raw: u128) -> Self

impl Bits for u32

const BITS: u32 = u32::BITS

fn into_bits(self) -> u128

fn from_bits(raw: u128) -> Self

impl Bits for u64

const BITS: u32 = u64::BITS

fn into_bits(self) -> u128

fn from_bits(raw: u128) -> Self

impl Bits for u128

const BITS: u32 = u128::BITS

fn into_bits(self) -> u128

fn from_bits(raw: u128) -> Self

Implementors

impl<const N: usize> Bits for UInt<u8, N>

const BITS: u32

impl<const N: usize> Bits for UInt<u16, N>

const BITS: u32

impl<const N: usize> Bits for UInt<u32, N>

const BITS: u32

impl<const N: usize> Bits for UInt<u64, N>

const BITS: u32

impl<const N: usize> Bits for UInt<u128, N>

const BITS: u32