Struct Bitfield

pub struct Bitfield { /* private fields */ }

A bitfield within a structure.

Bitfield provides information about the offset, size, bit position, and bit length of a bitfield member. It extends the functionality of Field by allowing access to individual bits within a field.

Implementations

impl Bitfield

pub fn new(offset: u64, size: u64, bit_position: u64, bit_length: u64) -> Self

Creates a new bitfield descriptor.

pub fn bit_position(&self) -> u64

Returns the starting bit position of the bitfield within the underlying field.

pub fn bit_length(&self) -> u64

Returns the length of the bitfield, in bits.

pub fn extract(&self, value: u64) -> u64

This method performs bitwise operations to isolate and return the value represented by the bitfield within the provided integer.

Methods from Deref<Target = Field>

pub fn offset(&self) -> u64

Returns the offset of the field from the beginning of the structure, in bytes.

pub fn size(&self) -> u64

Returns the size of the field, in bytes.

Trait Implementations

impl Clone for Bitfield

fn clone(&self) -> Bitfield

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bitfield

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

Formats the value using the given formatter.

impl Deref for Bitfield

type Target = Field

The resulting type after dereferencing.

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

Dereferences the value.

impl IntoField<Bitfield> for Result<FieldDescriptor, Error>

type Error = Error

fn into_field(self) -> Result<Bitfield, Error>

impl Copy for Bitfield