Struct BitSpan 

pub struct BitSpan<T> {
    pub start: u32,
    pub end: u32,
    pub width: u32,
    pub mask: T,
    pub max: T,
}

▫️ 🗃️ A contiguous span of bits in an integer carrier.

---

^{📍 bin}

---

Stores the bounds and derived masks for a packed field.

Fields

start: u32

First bit in the span.

end: u32

Last bit in the span.

width: u32

Number of bits in the span.

mask: T

Shifted mask covering the span.

max: T

Maximum value that fits in the span.

Implementations

impl<T> BitSpan<T>

pub const fn from_parts(start: u32, end: u32, mask: T, max: T) -> Self

Returns a new bit span from precomputed metadata.

Panics

Panics if start > end.

impl<T: Copy> BitSpan<T>

pub const fn is_single(self) -> bool

Returns whether the span occupies exactly one bit.

pub const fn contains_bit(self, bit: u32) -> bool

Returns whether bit is inside the span.

pub const fn contains_span(self, other: Self) -> bool

Returns whether other is fully inside self.

pub const fn overlaps(self, other: Self) -> bool

Returns whether both spans share any bits.

pub const fn is_disjoint(self, other: Self) -> bool

Returns whether both spans share no bits.

pub const fn fits_in(self, bits: u32) -> bool

Returns whether the span fits in a carrier with bits bits.

impl BitSpan<u8>

pub const fn new(start: u32, end: u32) -> Self

Returns a new bit span.

Panics

Panics if start > end or if end exceeds the carrier width.

pub const fn try_new(start: u32, end: u32) -> Result<Self, MismatchedBounds>

Returns a new checked bit span.

Errors

Returns an error if start > end or if end exceeds the carrier width.

pub const fn value_fits(self, value: u8) -> bool

Returns whether value fits in this span.

pub const fn get_value(self, bits: u8) -> u8

Extracts the span value from bits.

pub const fn set_value(self, bits: u8, value: u8) -> u8

Returns bits with the span value replaced.

The value is masked to fit the span width.

pub const fn try_set_value( self, bits: u8, value: u8, ) -> Result<u8, MismatchedBounds>

Returns bits with the checked span value replaced.

Errors

Returns an error if the span is invalid or if value does not fit within the span width.

pub const fn clear_in(self, bits: u8) -> u8

Clears the span bits in bits.

pub const fn is_full_in(self, bits: u8) -> bool

Returns whether every span bit is set in bits.

pub const fn is_zero_in(self, bits: u8) -> bool

Returns whether no span bit is set in bits.

impl BitSpan<u16>

pub const fn new(start: u32, end: u32) -> Self

Returns a new bit span.

Panics

Panics if start > end or if end exceeds the carrier width.

pub const fn try_new(start: u32, end: u32) -> Result<Self, MismatchedBounds>

Returns a new checked bit span.

Errors

Returns an error if start > end or if end exceeds the carrier width.

pub const fn value_fits(self, value: u16) -> bool

Returns whether value fits in this span.

pub const fn get_value(self, bits: u16) -> u16

Extracts the span value from bits.

pub const fn set_value(self, bits: u16, value: u16) -> u16

Returns bits with the span value replaced.

The value is masked to fit the span width.

pub const fn try_set_value( self, bits: u16, value: u16, ) -> Result<u16, MismatchedBounds>

Returns bits with the checked span value replaced.

Errors

Returns an error if the span is invalid or if value does not fit within the span width.

pub const fn clear_in(self, bits: u16) -> u16

Clears the span bits in bits.

pub const fn is_full_in(self, bits: u16) -> bool

Returns whether every span bit is set in bits.

pub const fn is_zero_in(self, bits: u16) -> bool

Returns whether no span bit is set in bits.

impl BitSpan<u32>

pub const fn new(start: u32, end: u32) -> Self

Returns a new bit span.

Panics

Panics if start > end or if end exceeds the carrier width.

pub const fn try_new(start: u32, end: u32) -> Result<Self, MismatchedBounds>

Returns a new checked bit span.

Errors

Returns an error if start > end or if end exceeds the carrier width.

pub const fn value_fits(self, value: u32) -> bool

Returns whether value fits in this span.

pub const fn get_value(self, bits: u32) -> u32

Extracts the span value from bits.

pub const fn set_value(self, bits: u32, value: u32) -> u32

Returns bits with the span value replaced.

The value is masked to fit the span width.

pub const fn try_set_value( self, bits: u32, value: u32, ) -> Result<u32, MismatchedBounds>

Returns bits with the checked span value replaced.

Errors

Returns an error if the span is invalid or if value does not fit within the span width.

pub const fn clear_in(self, bits: u32) -> u32

Clears the span bits in bits.

pub const fn is_full_in(self, bits: u32) -> bool

Returns whether every span bit is set in bits.

pub const fn is_zero_in(self, bits: u32) -> bool

Returns whether no span bit is set in bits.

impl BitSpan<u64>

pub const fn new(start: u32, end: u32) -> Self

Returns a new bit span.

Panics

Panics if start > end or if end exceeds the carrier width.

pub const fn try_new(start: u32, end: u32) -> Result<Self, MismatchedBounds>

Returns a new checked bit span.

Errors

Returns an error if start > end or if end exceeds the carrier width.

pub const fn value_fits(self, value: u64) -> bool

Returns whether value fits in this span.

pub const fn get_value(self, bits: u64) -> u64

Extracts the span value from bits.

pub const fn set_value(self, bits: u64, value: u64) -> u64

Returns bits with the span value replaced.

The value is masked to fit the span width.

pub const fn try_set_value( self, bits: u64, value: u64, ) -> Result<u64, MismatchedBounds>

Returns bits with the checked span value replaced.

Errors

Returns an error if the span is invalid or if value does not fit within the span width.

pub const fn clear_in(self, bits: u64) -> u64

Clears the span bits in bits.

pub const fn is_full_in(self, bits: u64) -> bool

Returns whether every span bit is set in bits.

pub const fn is_zero_in(self, bits: u64) -> bool

Returns whether no span bit is set in bits.

impl BitSpan<u128>

pub const fn new(start: u32, end: u32) -> Self

Returns a new bit span.

Panics

Panics if start > end or if end exceeds the carrier width.

pub const fn try_new(start: u32, end: u32) -> Result<Self, MismatchedBounds>

Returns a new checked bit span.

Errors

Returns an error if start > end or if end exceeds the carrier width.

pub const fn value_fits(self, value: u128) -> bool

Returns whether value fits in this span.

pub const fn get_value(self, bits: u128) -> u128

Extracts the span value from bits.

pub const fn set_value(self, bits: u128, value: u128) -> u128

Returns bits with the span value replaced.

The value is masked to fit the span width.

pub const fn try_set_value( self, bits: u128, value: u128, ) -> Result<u128, MismatchedBounds>

Returns bits with the checked span value replaced.

Errors

Returns an error if the span is invalid or if value does not fit within the span width.

pub const fn clear_in(self, bits: u128) -> u128

Clears the span bits in bits.

pub const fn is_full_in(self, bits: u128) -> bool

Returns whether every span bit is set in bits.

pub const fn is_zero_in(self, bits: u128) -> bool

Returns whether no span bit is set in bits.

impl BitSpan<usize>

pub const fn new(start: u32, end: u32) -> Self

Returns a new bit span.

Panics

Panics if start > end or if end exceeds the carrier width.

pub const fn try_new(start: u32, end: u32) -> Result<Self, MismatchedBounds>

Returns a new checked bit span.

Errors

Returns an error if start > end or if end exceeds the carrier width.

pub const fn value_fits(self, value: usize) -> bool

Returns whether value fits in this span.

pub const fn get_value(self, bits: usize) -> usize

Extracts the span value from bits.

pub const fn set_value(self, bits: usize, value: usize) -> usize

Returns bits with the span value replaced.

The value is masked to fit the span width.

pub const fn try_set_value( self, bits: usize, value: usize, ) -> Result<usize, MismatchedBounds>

Returns bits with the checked span value replaced.

Errors

Returns an error if the span is invalid or if value does not fit within the span width.

pub const fn clear_in(self, bits: usize) -> usize

Clears the span bits in bits.

pub const fn is_full_in(self, bits: usize) -> bool

Returns whether every span bit is set in bits.

pub const fn is_zero_in(self, bits: usize) -> bool

Returns whether no span bit is set in bits.

Trait Implementations

impl<T: Clone> Clone for BitSpan<T>

fn clone(&self) -> BitSpan<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for BitSpan<T>

impl<T: Debug> Debug for BitSpan<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for BitSpan<T>

impl<T: Hash> Hash for BitSpan<T>

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> Ord for BitSpan<T>

fn cmp(&self, other: &BitSpan<T>) -> 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> PartialEq for BitSpan<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: PartialOrd> PartialOrd for BitSpan<T>

fn partial_cmp(&self, other: &BitSpan<T>) -> 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> StructuralPartialEq for BitSpan<T>