Struct UInt 

pub struct UInt<T, const N: usize> { /* private fields */ }

An unsigned integer constrained to N bits, backed by primitive T.

Use the aliases (u5, u13, …) rather than naming T directly. The value is always in 0..=MAX (MAX == 2^N - 1); construct with new (panicking) or try_new (checked), and read it back with value.

Examples

use bnb::u5;

let a = u5::new(17);              // checked; panics if > 31
assert_eq!(a.value(), 17);
assert!(u5::try_new(32).is_err()); // out of range -> Err, no panic
assert_eq!(u5::from_raw(0xFF).value(), 31); // masks to the low 5 bits
assert_eq!(u5::MAX.value(), 31);
assert_eq!(u5::MIN.value(), 0);

Implementations

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

pub const BITS: u32 = <Self as Bits>::BITS

The number of bits.

pub const MASK: u8

A mask with the low N bits set.

pub const MAX: Self

The largest representable value (2^N - 1).

pub const MIN: Self

The zero value.

pub const fn new(value: u8) -> Self

Creates a value, panicking if it does not fit in N bits.

Panics

Panics if value > MAX.

pub fn try_new(value: u8) -> Result<Self, WidthError>

Creates a value, or WidthError::ValueTooLarge if it does not fit in N bits.

pub const fn from_raw(value: u8) -> Self

Creates a value from the low N bits of value, discarding any higher bits (the unchecked, masking constructor).

pub const fn value(self) -> u8

The underlying value.

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

pub const BITS: u32 = <Self as Bits>::BITS

The number of bits.

pub const MASK: u16

A mask with the low N bits set.

pub const MAX: Self

The largest representable value (2^N - 1).

pub const MIN: Self

The zero value.

pub const fn new(value: u16) -> Self

Creates a value, panicking if it does not fit in N bits.

Panics

Panics if value > MAX.

pub fn try_new(value: u16) -> Result<Self, WidthError>

Creates a value, or WidthError::ValueTooLarge if it does not fit in N bits.

pub const fn from_raw(value: u16) -> Self

Creates a value from the low N bits of value, discarding any higher bits (the unchecked, masking constructor).

pub const fn value(self) -> u16

The underlying value.

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

pub const BITS: u32 = <Self as Bits>::BITS

The number of bits.

pub const MASK: u32

A mask with the low N bits set.

pub const MAX: Self

The largest representable value (2^N - 1).

pub const MIN: Self

The zero value.

pub const fn new(value: u32) -> Self

Creates a value, panicking if it does not fit in N bits.

Panics

Panics if value > MAX.

pub fn try_new(value: u32) -> Result<Self, WidthError>

Creates a value, or WidthError::ValueTooLarge if it does not fit in N bits.

pub const fn from_raw(value: u32) -> Self

Creates a value from the low N bits of value, discarding any higher bits (the unchecked, masking constructor).

pub const fn value(self) -> u32

The underlying value.

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

pub const BITS: u32 = <Self as Bits>::BITS

The number of bits.

pub const MASK: u64

A mask with the low N bits set.

pub const MAX: Self

The largest representable value (2^N - 1).

pub const MIN: Self

The zero value.

pub const fn new(value: u64) -> Self

Creates a value, panicking if it does not fit in N bits.

Panics

Panics if value > MAX.

pub fn try_new(value: u64) -> Result<Self, WidthError>

Creates a value, or WidthError::ValueTooLarge if it does not fit in N bits.

pub const fn from_raw(value: u64) -> Self

Creates a value from the low N bits of value, discarding any higher bits (the unchecked, masking constructor).

pub const fn value(self) -> u64

The underlying value.

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

pub const BITS: u32 = <Self as Bits>::BITS

The number of bits.

pub const MASK: u128

A mask with the low N bits set.

pub const MAX: Self

The largest representable value (2^N - 1).

pub const MIN: Self

The zero value.

pub const fn new(value: u128) -> Self

Creates a value, panicking if it does not fit in N bits.

Panics

Panics if value > MAX.

pub fn try_new(value: u128) -> Result<Self, WidthError>

Creates a value, or WidthError::ValueTooLarge if it does not fit in N bits.

pub const fn from_raw(value: u128) -> Self

Creates a value from the low N bits of value, discarding any higher bits (the unchecked, masking constructor).

pub const fn value(self) -> u128

The underlying value.

Trait Implementations

impl<T, const N: usize> BitDecode for UInt<T, N>

where UInt<T, N>: Bits,

fn bit_decode<S: Source>(r: &mut S) -> Result<Self, BitError>

Decodes Self from any Source, advancing its cursor.

impl<T, const N: usize> BitEncode for UInt<T, N>

where UInt<T, N>: Bits,

fn bit_encode<K: Sink>(&self, w: &mut K) -> Result<(), BitError>

Encodes self verbatim into any Sink, advancing its cursor.

const LAYOUT: Layout = _

The message’s bit/byte order, used to size a fresh BitWriter when encoding to a Vec/writer. The derive sets it from the struct’s declared bit_order/bytes; a hand-written impl that only ever encodes into a caller-supplied Sink can leave the default.

fn canonical_bit_encode<K: Sink>(&self, w: &mut K) -> Result<(), BitError>

Encodes self’s canonical form into any Sink: reserved fields as their spec value, calc fields recomputed. Defaults to bit_encode (verbatim == canonical) for messages with no reserved/calc field.

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

const BITS: u32

The number of bits this value occupies on the wire.

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.

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

const BITS: u32

The number of bits this value occupies on the wire.

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.

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

const BITS: u32

The number of bits this value occupies on the wire.

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.

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

const BITS: u32

The number of bits this value occupies on the wire.

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.

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

const BITS: u32

The number of bits this value occupies on the wire.

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.

impl<T: Clone, const N: usize> Clone for UInt<T, N>

fn clone(&self) -> UInt<T, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy, const N: usize> Copy for UInt<T, N>

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

fn try_from_count(len: usize) -> Result<Self, WidthError>

The prefix for a collection of len elements, or [WidthError::ValueTooLarge] when len exceeds the prefix’s range.

fn to_count(self) -> usize

The prefix as an element count.

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

fn try_from_count(len: usize) -> Result<Self, WidthError>

The prefix for a collection of len elements, or [WidthError::ValueTooLarge] when len exceeds the prefix’s range.

fn to_count(self) -> usize

The prefix as an element count.

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

fn try_from_count(len: usize) -> Result<Self, WidthError>

The prefix for a collection of len elements, or [WidthError::ValueTooLarge] when len exceeds the prefix’s range.

fn to_count(self) -> usize

The prefix as an element count.

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

fn try_from_count(len: usize) -> Result<Self, WidthError>

The prefix for a collection of len elements, or [WidthError::ValueTooLarge] when len exceeds the prefix’s range.

fn to_count(self) -> usize

The prefix as an element count.

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

fn try_from_count(len: usize) -> Result<Self, WidthError>

The prefix for a collection of len elements, or [WidthError::ValueTooLarge] when len exceeds the prefix’s range.

fn to_count(self) -> usize

The prefix as an element count.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn default() -> Self

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<T: Eq, const N: usize> Eq for UInt<T, N>

impl<T, const N: usize> FixedBitLen for UInt<T, N>

where UInt<T, N>: Bits,

const BIT_LEN: u32 = <Self as Bits>::BITS

Total encoded width of the message in bits — the sum of its fields’ widths.

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

fn from(v: UInt<u8, N>) -> u8

Converts to this type from the input type.

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

fn from(v: UInt<u16, N>) -> u16

Converts to this type from the input type.

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

fn from(v: UInt<u32, N>) -> u32

Converts to this type from the input type.

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

fn from(v: UInt<u64, N>) -> u64

Converts to this type from the input type.

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

fn from(v: UInt<u128, N>) -> u128

Converts to this type from the input type.

impl<T: Hash, const N: usize> Hash for UInt<T, N>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord, const N: usize> Ord for UInt<T, N>

fn cmp(&self, other: &UInt<T, N>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq, const N: usize> PartialEq for UInt<T, N>

fn eq(&self, other: &UInt<T, N>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd, const N: usize> PartialOrd for UInt<T, N>

fn partial_cmp(&self, other: &UInt<T, N>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: PartialEq, const N: usize> StructuralPartialEq for UInt<T, N>

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

type Error = WidthError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, WidthError>

Performs the conversion.

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

type Error = WidthError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, WidthError>

Performs the conversion.

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

type Error = WidthError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, WidthError>

Performs the conversion.

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

type Error = WidthError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, WidthError>

Performs the conversion.

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

type Error = WidthError

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<Self, WidthError>

Performs the conversion.