Skip to main content

BitField

Struct BitField 

Source
pub struct BitField {
    pub width: u32,
    pub bit_offset: u64,
    pub signed: bool,
    pub storage: String,
    pub storage_offset: u64,
    pub getter: String,
    pub setter: String,
}
Expand description

What makes a member a bit-field (C99 6.7.2.1).

A bit-field has no address of its own, so it is not a Rust field: a maximal run of them shares one [u8; K] storage field, and reading or writing one goes through a pair of generated accessors. Everything code generation needs to emit those — where the bits are and how wide they are — lives here.

Fields§

§width: u32

The declared width, in bits.

§bit_offset: u64

The bit offset from the start of the record, counting from the least significant bit of byte 0 (the little-endian bit order every ABI this crate targets uses).

§signed: bool

Whether reading the field sign-extends.

Usually the signedness of the declared type; an enum bit-field follows the enumeration’s underlying type instead, which GCC and Clang make unsigned when no enumerator is negative.

§storage: String

The name of the [u8; K] field the bits live in.

§storage_offset: u64

The byte offset of that field within the record.

§getter: String

The name of the generated getter.

§setter: String

The name of the generated setter.

Implementations§

Source§

impl BitField

Source

pub fn offset_in_storage(&self) -> u64

The bit offset of the field within its storage array.

Trait Implementations§

Source§

impl Clone for BitField

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BitField

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.