Struct ExampleBitfield

pub struct ExampleBitfield { /* private fields */ }

Available on (doc or test) and crate feature _bit_u8 only.

An example created with bitfield!, everything public.

use devela::bitfield;

bitfield! {
    /// An example created with [`bitfield!`], everything public.
    pub struct ExampleBitfield(u8) {
        /// Documentation for the first field.
        FLAG1: 0;
        /// Documentation for the second field.
        FLAG2: 1;
        MASK: 0, 1;
    }
}

let mut b = ExampleBitfield::with_field_mask();
assert![b.is_field_mask()];
assert![b.is_field_flag1()];
assert![b.is_field_flag2()];
let _c = b.unset_field_flag1();

Implementations

impl ExampleBitfield

pub const FLAG1: Self

Documentation for the first field.

pub const FLAG2: Self

Documentation for the second field.

pub const MASK0: Self

impl ExampleBitfield

Custom fields operations

pub const fn without_fields() -> Self

Returns a new ExampleBitfield with none of the fields set.

pub const fn with_all_fields() -> Self

Returns a new ExampleBitfield with all the fields set.

pub const fn are_all_fields(self) -> bool

Returns true if it all the fields are set.

impl ExampleBitfield

FLAG1 single field operations

pub const fn with_field_flag1() -> Self

Returns a new ExampleBitfield with FLAG1 field set.

pub const fn is_field_flag1(self) -> bool

Whether the FLAG1 field is set.

pub const fn bits_field_flag1(self) -> u32

The size in bits of the FLAG1 field.

pub const fn get_field_flag1(self) -> Self

A copy of self with only the bits of FLAG1 field.

pub const fn set_field_flag1(self) -> Self

A copy of self with the FLAG1 field set.

pub fn mut_set_field_flag1(&mut self)

Sets the FLAG1 field.

pub const fn get_field_value_flag1(self) -> Self

The value at the bit range of FLAG1 field.

pub const fn set_field_value_flag1(self, value: u8) -> Self

Sets the value into the bitrange of FLAG1 field.

pub const fn unset_field_flag1(self) -> Self

A copy of self with the FLAG1 field set.

pub fn mut_unset_field_flag1(&mut self)

Unsets the FLAG1 field.

pub const fn flip_field_flag1(self) -> Self

Returns a copy of self with the FLAG1 field flipped.

pub fn mut_flip_field_flag1(&mut self)

Flips the FLAG1 field.

impl ExampleBitfield

FLAG2 single field operations

pub const fn with_field_flag2() -> Self

Returns a new ExampleBitfield with FLAG2 field set.

pub const fn is_field_flag2(self) -> bool

Whether the FLAG2 field is set.

pub const fn bits_field_flag2(self) -> u32

The size in bits of the FLAG2 field.

pub const fn get_field_flag2(self) -> Self

A copy of self with only the bits of FLAG2 field.

pub const fn set_field_flag2(self) -> Self

A copy of self with the FLAG2 field set.

pub fn mut_set_field_flag2(&mut self)

Sets the FLAG2 field.

pub const fn get_field_value_flag2(self) -> Self

The value at the bit range of FLAG2 field.

pub const fn set_field_value_flag2(self, value: u8) -> Self

Sets the value into the bitrange of FLAG2 field.

pub const fn unset_field_flag2(self) -> Self

A copy of self with the FLAG2 field set.

pub fn mut_unset_field_flag2(&mut self)

Unsets the FLAG2 field.

pub const fn flip_field_flag2(self) -> Self

Returns a copy of self with the FLAG2 field flipped.

pub fn mut_flip_field_flag2(&mut self)

Flips the FLAG2 field.

impl ExampleBitfield

MASK0 single field operations

pub const fn with_field_mask0() -> Self

Returns a new ExampleBitfield with MASK0 field set.

pub const fn is_field_mask0(self) -> bool

Whether the MASK0 field is set.

pub const fn bits_field_mask0(self) -> u32

The size in bits of the MASK0 field.

pub const fn get_field_mask0(self) -> Self

A copy of self with only the bits of MASK0 field.

pub const fn set_field_mask0(self) -> Self

A copy of self with the MASK0 field set.

pub fn mut_set_field_mask0(&mut self)

Sets the MASK0 field.

pub const fn get_field_value_mask0(self) -> Self

The value at the bit range of MASK0 field.

pub const fn set_field_value_mask0(self, value: u8) -> Self

Sets the value into the bitrange of MASK0 field.

pub const fn unset_field_mask0(self) -> Self

A copy of self with the MASK0 field set.

pub fn mut_unset_field_mask0(&mut self)

Unsets the MASK0 field.

pub const fn flip_field_mask0(self) -> Self

Returns a copy of self with the MASK0 field flipped.

pub fn mut_flip_field_mask0(&mut self)

Flips the MASK0 field.

impl ExampleBitfield

General bits manipulation functionality

pub const MAX_BIT: u32 = 7u32

the maximum valid bit index.

pub const fn with_bits(bits: u8) -> Self

Returns self with the given inner bits.

pub const fn new_zeroed() -> Self

Returns self with all bits set to 0.

pub const fn new_oned() -> Self

Returns self with all bits set to 1.

pub const fn bits(self) -> u8

Returns the inner bits.

pub const fn count_ones(&self) -> u32

The number of bits set (number of ones).

pub const fn count_zeros(&self) -> u32

The number of bits unset (number of zeros).

pub const fn is_empty(self) -> bool

Wether all bits are set to 0.

pub const fn is_full(self) -> bool

Whether all bits are set to 1.

pub const fn is_bit_set(self, index: u32) -> bool

Whether the bit at index is set.

Panics

Panics in debug if index > MAX_BIT.

pub const fn is_checked_bit_set( self, index: u32, ) -> Result<bool, MismatchedBounds>

Whether the bit at index is set, checked version.

Errors

• If index > MAX_BIT Returns

pub const fn get_bit(self, index: u32) -> Self

Returns a copy of self with only the value of the bit at index.

Panics

Panics in debug if index > MAX_BIT.

pub const fn get_checked_bit(self, index: u32) -> Result<Self, MismatchedBounds>

Returns a copy of self with only the value of the bit at index, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub const fn get_shifted_bit(self, index: u32) -> Self

Returns a copy of self with only the value of the bit at index shifted.

Panics

Panics in debug if index > MAX_BIT.

pub const fn get_shifted_checked_bit( self, index: u32, ) -> Result<Self, MismatchedBounds>

Returns a copy of self with only the value of the bit at index shifted, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub fn set_bit(self, index: u32) -> Self

Returns a copy of self setting the bit at index.

Panics

Panics in debug if index > MAX_BIT.

pub const fn set_checked_bit(self, index: u32) -> Result<Self, MismatchedBounds>

Returns a copy of self setting the bit at index, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub fn mut_set_bit(&mut self, index: u32)

Sets the bit at index.

Panics

Panics in debug if index > MAX_BIT.

pub fn mut_set_checked_bit( &mut self, index: u32, ) -> Result<(), MismatchedBounds>

Sets the bit at index, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub fn unset_bit(self, index: u32) -> Self

Returns a copy of self setting the bit at index.

Panics

Panics in debug if index > MAX_BIT.

pub const fn unset_checked_bit( self, index: u32, ) -> Result<Self, MismatchedBounds>

Returns a copy of self unsetting the bit at index, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub fn mut_unset_bit(&mut self, index: u32)

Unsets the bit at index.

Panics

Panics in debug if index > MAX_BIT.

pub fn mut_unset_checked_bit( &mut self, index: u32, ) -> Result<(), MismatchedBounds>

Unsets the bit at index, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub const fn flip(self) -> Self

Returns a copy of self with all its bits flipped.

pub fn mut_flip(&mut self)

Flips all the bits of self.

pub fn flip_bit(self, index: u32) -> Self

Returns a copy of self flipping the bit at index.

Panics

Panics in debug if index > MAX_BIT.

pub const fn flip_checked_bit( self, index: u32, ) -> Result<Self, MismatchedBounds>

Returns a copy of self flipping the bit at index, checked.

Errors

Returns IndexOutOfBounds if index > MAX_BIT.

pub fn mut_flip_bit(&mut self, index: u32)

Flips the bit at index, unchecked version.

Panics

Panics in debug if index > MAX_BIT.

pub fn mut_flip_checked_bit( &mut self, index: u32, ) -> Result<(), MismatchedBounds>

Flips the bit at index, checked.

impl ExampleBitfield

Bit ranges

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

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

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

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

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

Gets a copy of self with only the bits from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

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

Gets a copy of self with only the bits from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

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

Gets the value of the bits in from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

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

Gets the value of the bits from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

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

Get a copy of self with bits set to 1 from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

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

Get a copy of self with bits set to 1 from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

pub fn mut_set_range(&mut self, start: u32, end: u32)

Sets the bits from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

pub fn mut_set_checked_range( &mut self, start: u32, end: u32, ) -> Result<(), MismatchedBounds>

Sets the bits from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

pub const fn set_value_range(self, value: u8, start: u32, end: u32) -> Self

Gets a copy of self with the given value set into the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: u8, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Gets a copy of self with the given value set into the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: u8, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Gets a copy of self with the given checked value set into the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub fn mut_set_value_range(&mut self, value: u8, start: u32, end: u32)

Sets the given value into the [start..=end] range. Sets the bits from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

pub fn mut_set_value_checked_range( &mut self, value: u8, start: u32, end: u32, ) -> Result<(), MismatchedBounds>

Sets the given value into the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT and MismatchedIndices if start > end.

pub fn mut_set_checked_value_checked_range( &mut self, value: u8, start: u32, end: u32, ) -> Result<(), MismatchedBounds>

Sets the given checked value into the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

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

Returns a copy of self with unset bits to 0 from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

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

Returns a copy of self with unset bits to 0 from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

pub fn mut_unset_range(&mut self, start: u32, end: u32)

Unsets the bits from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

pub fn mut_unset_checked_range( &mut self, start: u32, end: u32, ) -> Result<(), MismatchedBounds>

Unsets the bits from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

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

Returns a copy of self with flipped bits from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

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

Returns a copy of self with flipped bits from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

pub fn mut_flip_range(&mut self, start: u32, end: u32)

Flips the bits from the [start..=end] range.

Panics

Panics in debug if start > MAX_BIT || end > MAX_BIT or if start > end.

pub fn mut_flip_checked_range( &mut self, start: u32, end: u32, ) -> Result<(), MismatchedBounds>

Flips the bits from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start > MAX_BIT || end > MAX_BIT, or MismatchedIndices if start > end.

impl ExampleBitfield

Bit masks

pub const fn contains_mask(self, mask: u8) -> bool

Whether self contains all the same set bits that are set in mask.

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

Whether self contains all the same set bits that are set in other.

pub const fn overlaps_mask(&self, mask: u8) -> bool

Whether there’s at least one set bit in common between self and mask.

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

Whether there’s at least one set bit in common between self and other.

pub const fn intersect_mask(self, mask: u8) -> Self

A copy of self with only the bits both in self and mask.

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

A copy of self with only the bits both in self and other.

pub fn mut_intersect_mask(&mut self, mask: u8)

Only leaves the bits both in self and mask.

pub fn mut_intersect_other(&mut self, other: Self)

Only leaves the bits both in self and other.

pub const fn set_mask(self, mask: u8) -> Self

A copy of self setting the bits that are set in mask.

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

A copy of self setting the bits that are set in other.

pub fn mut_set_mask(&mut self, mask: u8)

Sets the bits that are set in mask.

pub fn mut_set_other(&mut self, other: Self)

Sets the bits that are set in other.

pub const fn unset_mask(self, mask: u8) -> Self

A copy of self unsetting the bits that are set in mask.

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

A copy of self unsetting the bits that are set in other.

pub fn mut_unset_mask(&mut self, mask: u8)

Unsets the bits that are set in mask.

pub fn mut_unset_other(&mut self, other: Self)

Unsets the bits that are set in other.

pub const fn flip_mask(self, mask: u8) -> Self

A copy of self flipping the bits that are set in mask.

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

Returns a copy of self flipping the bits that are set in other.

pub fn mut_flip_mask(&mut self, mask: u8)

Flips the bits that are set in mask.

pub fn mut_flip_other(&mut self, other: Self)

Flips the bits that are set in other.

Trait Implementations

impl Binary for ExampleBitfield

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

Formats the value using the given formatter.

impl Clone for ExampleBitfield

fn clone(&self) -> ExampleBitfield

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExampleBitfield

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

Formats the value using the given formatter.

impl Default for ExampleBitfield

fn default() -> Self

Returns the “default value” for a type.

impl Display for ExampleBitfield

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

Formats the value using the given formatter.

impl Hash for ExampleBitfield

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 LowerExp for ExampleBitfield

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

Formats the value using the given formatter.

impl LowerHex for ExampleBitfield

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

Formats the value using the given formatter.

impl Octal for ExampleBitfield

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

Formats the value using the given formatter.

impl Ord for ExampleBitfield

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

fn eq(&self, other: &ExampleBitfield) -> 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 PartialOrd for ExampleBitfield

fn partial_cmp(&self, other: &ExampleBitfield) -> 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 UpperExp for ExampleBitfield

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

Formats the value using the given formatter.

impl UpperHex for ExampleBitfield

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

Formats the value using the given formatter.

impl Copy for ExampleBitfield

impl Eq for ExampleBitfield

impl StructuralPartialEq for ExampleBitfield