Struct UType

pub struct UType { /* private fields */ }

Implementations

impl UType

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl UType

pub const fn into_bytes(self) -> [u8; 4]

Returns the underlying bits.

Layout

The returned byte array is layed out in the same way as described here.

pub const fn from_bytes(bytes: [u8; 4]) -> Self

Converts the given bytes directly into the bitfield struct.

impl UType

pub fn opcode(&self) -> <B7 as Specifier>::InOut

Returns the value of opcode.

pub fn opcode_or_err( &self, ) -> Result<<B7 as Specifier>::InOut, InvalidBitPattern<<B7 as Specifier>::Bytes>>

Returns the value of opcode.

#Errors

If the returned value contains an invalid bit pattern for opcode.

pub fn with_opcode(self, new_val: <B7 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of opcode set to the given value.

#Panics

If the given value is out of bounds for opcode.

pub fn with_opcode_checked( self, new_val: <B7 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of opcode set to the given value.

#Errors

If the given value is out of bounds for opcode.

pub fn set_opcode(&mut self, new_val: <B7 as Specifier>::InOut)

Sets the value of opcode to the given value.

#Panics

If the given value is out of bounds for opcode.

pub fn set_opcode_checked( &mut self, new_val: <B7 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of opcode to the given value.

#Errors

If the given value is out of bounds for opcode.

pub fn rd(&self) -> <B5 as Specifier>::InOut

Returns the value of rd.

pub fn rd_or_err( &self, ) -> Result<<B5 as Specifier>::InOut, InvalidBitPattern<<B5 as Specifier>::Bytes>>

Returns the value of rd.

#Errors

If the returned value contains an invalid bit pattern for rd.

pub fn with_rd(self, new_val: <B5 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of rd set to the given value.

#Panics

If the given value is out of bounds for rd.

pub fn with_rd_checked( self, new_val: <B5 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of rd set to the given value.

#Errors

If the given value is out of bounds for rd.

pub fn set_rd(&mut self, new_val: <B5 as Specifier>::InOut)

Sets the value of rd to the given value.

#Panics

If the given value is out of bounds for rd.

pub fn set_rd_checked( &mut self, new_val: <B5 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of rd to the given value.

#Errors

If the given value is out of bounds for rd.

pub fn imm31_12(&self) -> <B20 as Specifier>::InOut

Returns the value of imm31_12.

pub fn imm31_12_or_err( &self, ) -> Result<<B20 as Specifier>::InOut, InvalidBitPattern<<B20 as Specifier>::Bytes>>

Returns the value of imm31_12.

#Errors

If the returned value contains an invalid bit pattern for imm31_12.

pub fn with_imm31_12(self, new_val: <B20 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of imm31_12 set to the given value.

#Panics

If the given value is out of bounds for imm31_12.

pub fn with_imm31_12_checked( self, new_val: <B20 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of imm31_12 set to the given value.

#Errors

If the given value is out of bounds for imm31_12.

pub fn set_imm31_12(&mut self, new_val: <B20 as Specifier>::InOut)

Sets the value of imm31_12 to the given value.

#Panics

If the given value is out of bounds for imm31_12.

pub fn set_imm31_12_checked( &mut self, new_val: <B20 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of imm31_12 to the given value.

#Errors

If the given value is out of bounds for imm31_12.

Trait Implementations

impl CheckFillsUnalignedBits for UType

type CheckType = [(); 1]

impl Clone for UType

fn clone(&self) -> UType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UType

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

Formats the value using the given formatter.

impl PartialEq for UType

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

impl Eq for UType

impl StructuralPartialEq for UType