Struct deku::ctx::BitSize

pub struct BitSize(pub usize);

The number bits in a field

Implementations

impl BitSize

pub fn with_byte_size(byte_size: usize) -> Self

Convert the size in bytes to a bit size.

Examples

assert_eq!(BitSize::with_byte_size(1), BitSize(8));

Panic

Panic if byte_size * 8 is greater than usize::MAX.

pub fn of<T>() -> Self

Returns the bit size of a type.

Examples

assert_eq!(BitSize::of::<i32>(), BitSize(4 * 8));

Panics

Panic if the bit size of given type is greater than usize::MAX

pub fn of_val<T: ?Sized>(val: &T) -> Self

Returns the bit size of the pointed-to value

Trait Implementations

impl Clone for BitSize

fn clone(&self) -> BitSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BitSize

impl Debug for BitSize

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

Formats the value using the given formatter.

impl DekuRead<BitSize> for u8

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for u16

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for i128

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for isize

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for f32

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for f64

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for u32

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for u64

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for u128

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for usize

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for i8

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for i16

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for i32

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuRead<BitSize> for i64

fn read(
    input: &BitSlice<Msb0, u8>,
    bit_size: BitSize
) -> Result<(&BitSlice<Msb0, u8>, Self), DekuError>

Read bits and construct type * input - Input as bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for u8

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for u16

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for i128

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for isize

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for f32

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for f64

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for u32

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for u64

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for u128

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for usize

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for i8

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for i16

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for i32

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl DekuWrite<BitSize> for i64

fn write(&self, bit_size: BitSize) -> Result<BitVec<Msb0, u8>, DekuError>

Write type to bits * ctx - A context required by context-sensitive reading. A unit type () means no context needed.

impl Deref for BitSize

type Target = usize

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for BitSize

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Eq for BitSize

impl From<usize> for BitSize

fn from(n: usize) -> Self

Performs the conversion.

impl Into<usize> for BitSize

fn into(self) -> usize

Performs the conversion.

impl Ord for BitSize

fn cmp(&self, other: &BitSize) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<BitSize> for BitSize

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

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

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

This method tests for !=.

impl PartialOrd<BitSize> for BitSize

fn partial_cmp(&self, other: &BitSize) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &BitSize) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &BitSize) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &BitSize) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &BitSize) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for BitSize

impl StructuralPartialEq for BitSize