Struct BitfieldExample 

pub struct BitfieldExample { /* private fields */ }

Available on crate feature _docs_examples and (crate features _docs_examples) only.

✨ ▫️ 🫗 🗃️ A compact packet header.

---

^{📍 data/codec}

---

It has been generated with the bitfield! macro like this:

bitfield! {
    /// A compact packet header.
    pub struct BitfieldExample(u16) {
        KIND    = 0..=3;
        VERSION = 4..=7;
        LENGTH  = 8..=15;
    }
}

Implementations

impl BitfieldExample

Named bit field masks.

These constants represent each field’s occupied bit range, not a field value.

Use them with mask-level methods such as contains_mask, with_mask and without_mask.

pub const KIND: Self

+

pub const VERSION: Self

+

pub const LENGTH: Self

+

impl BitfieldExample

pub const fn new() -> Self

Returns a new bitfield with all bits cleared.

pub const fn from_bits(bits: u16) -> Self

Returns a new bitfield from raw bits.

pub const fn bits(self) -> u16

Returns the raw backing bits.

pub const fn mask() -> u16

Returns the raw mask covering all declared fields.

pub const fn all() -> Self

Returns a bitfield value with every declared field bit set.

pub const fn is_empty(self) -> bool

Returns true if all raw bits are clear.

pub const fn is_full(self) -> bool

Returns true if the raw bits exactly equal the declared field mask.

pub const fn fields_are_zero(self) -> bool

Returns true if all declared field bits are clear.

pub const fn fields_are_full(self) -> bool

Returns true if all declared field bits are set.

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

Returns true if all bits in other are set in self.

This is a mask-level predicate. When used with a named field constant, it checks whether every bit occupied by that field is set.

pub const fn has_extra_bits(self) -> bool

Returns true if any bit outside the declared field mask is set.

pub const fn clear(&mut self)

Clears all bits.

pub const fn clear_fields(&mut self)

Clears all declared field bits, preserving bits outside the declared field mask.

pub const fn without_fields(self) -> Self

Returns self with all declared field bits cleared, preserving extra bits.

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

Returns self with all bits in other set.

This is a mask-level operation. Use with_FIELD(value) to replace a field value.

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

Returns self with all bits in other set if condition is true.

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

Returns self with all bits in other cleared.

This is a mask-level operation. It clears the occupied bits, regardless of the current field value.

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

Returns self with all bits in other cleared if condition is true.

impl BitfieldExample

Methods for KIND

pub const fn get_kind(self) -> u16

Returns the field value.

pub const fn with_kind(self, value: u16) -> Self

Returns self with the field value replaced, masking it to fit the field width.

pub const fn try_with_kind(self, value: u16) -> Result<Self, MismatchedCapacity>

Returns self with the checked field value replaced, if it fits.

pub const fn set_kind(&mut self, value: u16)

Replaces the field value, masking it to fit the field width.

pub const fn try_set_kind( &mut self, value: u16, ) -> Result<(), MismatchedCapacity>

Replaces the field value, if it fits.

pub const fn clear_kind(&mut self)

Clears the field value.

pub const fn is_kind_zero(self) -> bool

Returns true if the field value is zero.

pub const fn is_kind_max(self) -> bool

Returns true if the field value equals its maximum.

pub const fn kind_span() -> BitSpan<u16>

Returns metadata for this field.

impl BitfieldExample

Methods for VERSION

pub const fn get_version(self) -> u16

Returns the field value.

pub const fn with_version(self, value: u16) -> Self

Returns self with the field value replaced, masking it to fit the field width.

pub const fn try_with_version( self, value: u16, ) -> Result<Self, MismatchedCapacity>

Returns self with the checked field value replaced, if it fits.

pub const fn set_version(&mut self, value: u16)

Replaces the field value, masking it to fit the field width.

pub const fn try_set_version( &mut self, value: u16, ) -> Result<(), MismatchedCapacity>

Replaces the field value, if it fits.

pub const fn clear_version(&mut self)

Clears the field value.

pub const fn is_version_zero(self) -> bool

Returns true if the field value is zero.

pub const fn is_version_max(self) -> bool

Returns true if the field value equals its maximum.

pub const fn version_span() -> BitSpan<u16>

Returns metadata for this field.

impl BitfieldExample

Methods for LENGTH

pub const fn get_length(self) -> u16

Returns the field value.

pub const fn with_length(self, value: u16) -> Self

Returns self with the field value replaced, masking it to fit the field width.

pub const fn try_with_length( self, value: u16, ) -> Result<Self, MismatchedCapacity>

Returns self with the checked field value replaced, if it fits.

pub const fn set_length(&mut self, value: u16)

Replaces the field value, masking it to fit the field width.

pub const fn try_set_length( &mut self, value: u16, ) -> Result<(), MismatchedCapacity>

Replaces the field value, if it fits.

pub const fn clear_length(&mut self)

Clears the field value.

pub const fn is_length_zero(self) -> bool

Returns true if the field value is zero.

pub const fn is_length_max(self) -> bool

Returns true if the field value equals its maximum.

pub const fn length_span() -> BitSpan<u16>

Returns metadata for this field.

Trait Implementations

impl Binary for BitfieldExample

Formats the set as a binary mask over its declared bit domain.

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

Formats the value using the given formatter.

impl BitSized<{ $Bitfield::_BITFIELD_BIT_SIZE }> for BitfieldExample

const BIT_SIZE: usize = _

The bit size of this type (only the relevant data part, without padding).

const MIN_BYTE_SIZE: usize = _

The rounded up byte size for this type.

fn bit_size(&self) -> usize

Returns the bit size of this type (only the relevant data part, without padding).

fn min_byte_size(&self) -> usize

Returns the rounded up byte size for this type.

impl Clone for BitfieldExample

fn clone(&self) -> BitfieldExample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstInit for BitfieldExample

const INIT: Self

Returns the compile-time “initial value” for a type.

impl Copy for BitfieldExample

impl Debug for BitfieldExample

Formats the bitfield as named field values.

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

Formats the value using the given formatter.

impl DebugExt for BitfieldExample

where BitfieldExample: Debug,

type Ctx = ReprMode

The context used to guide formatting.

fn fmt_with(&self, f: &mut Formatter<'_>, ctx: &Self::Ctx) -> FmtResult<()>

Formats self under the given context.

fn debug_with<'a>(&'a self, ctx: &'a Self::Ctx) -> DebugWith<'a, Self>

where Self: Sized,

Wraps self for contextual debug formatting.

impl Default for BitfieldExample

fn default() -> Self

Returns the “default value” for a type.

impl Display for BitfieldExample

Formats the bitfield as compact named field values.

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

Formats the value using the given formatter.

impl Eq for BitfieldExample

impl Hash for BitfieldExample

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 LowerHex for BitfieldExample

Formats the set as a hexadecimal mask over its declared bit domain.

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

Formats the value using the given formatter.

impl Octal for BitfieldExample

Formats the set as an octal mask over its declared bit domain.

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

Formats the value using the given formatter.

impl Ord for BitfieldExample

fn cmp(&self, other: &Self) -> 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 BitfieldExample

fn eq(&self, other: &Self) -> 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 BitfieldExample

fn partial_cmp(&self, other: &Self) -> 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 UpperHex for BitfieldExample

Formats the set as a hexadecimal mask over its declared bit domain.

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

Formats the value using the given formatter.