Struct CBIType

pub struct CBIType { /* private fields */ }

Implementations

impl CBIType

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl CBIType

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

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; 2]) -> Self

Converts the given bytes directly into the bitfield struct.

impl CBIType

pub fn op(&self) -> <B2 as Specifier>::InOut

Returns the value of op.

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

Returns the value of op.

#Errors

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

pub fn with_op(self, new_val: <B2 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for op.

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

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

#Errors

If the given value is out of bounds for op.

pub fn set_op(&mut self, new_val: <B2 as Specifier>::InOut)

Sets the value of op to the given value.

#Panics

If the given value is out of bounds for op.

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

Sets the value of op to the given value.

#Errors

If the given value is out of bounds for op.

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

Returns the value of imm4_0.

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

Returns the value of imm4_0.

#Errors

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

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

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

#Panics

If the given value is out of bounds for imm4_0.

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

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

#Errors

If the given value is out of bounds for imm4_0.

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

Sets the value of imm4_0 to the given value.

#Panics

If the given value is out of bounds for imm4_0.

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

Sets the value of imm4_0 to the given value.

#Errors

If the given value is out of bounds for imm4_0.

pub fn rd_or_rs1(&self) -> <B3 as Specifier>::InOut

Returns the value of rd_or_rs1.

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

Returns the value of rd_or_rs1.

#Errors

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

pub fn with_rd_or_rs1(self, new_val: <B3 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for rd_or_rs1.

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

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

#Errors

If the given value is out of bounds for rd_or_rs1.

pub fn set_rd_or_rs1(&mut self, new_val: <B3 as Specifier>::InOut)

Sets the value of rd_or_rs1 to the given value.

#Panics

If the given value is out of bounds for rd_or_rs1.

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

Sets the value of rd_or_rs1 to the given value.

#Errors

If the given value is out of bounds for rd_or_rs1.

pub fn funct2(&self) -> <B2 as Specifier>::InOut

Returns the value of funct2.

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

Returns the value of funct2.

#Errors

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

pub fn with_funct2(self, new_val: <B2 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for funct2.

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

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

#Errors

If the given value is out of bounds for funct2.

pub fn set_funct2(&mut self, new_val: <B2 as Specifier>::InOut)

Sets the value of funct2 to the given value.

#Panics

If the given value is out of bounds for funct2.

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

Sets the value of funct2 to the given value.

#Errors

If the given value is out of bounds for funct2.

pub fn imm5(&self) -> <B1 as Specifier>::InOut

Returns the value of imm5.

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

Returns the value of imm5.

#Errors

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

pub fn with_imm5(self, new_val: <B1 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for imm5.

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

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

#Errors

If the given value is out of bounds for imm5.

pub fn set_imm5(&mut self, new_val: <B1 as Specifier>::InOut)

Sets the value of imm5 to the given value.

#Panics

If the given value is out of bounds for imm5.

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

Sets the value of imm5 to the given value.

#Errors

If the given value is out of bounds for imm5.

pub fn funct3(&self) -> <B3 as Specifier>::InOut

Returns the value of funct3.

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

Returns the value of funct3.

#Errors

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

pub fn with_funct3(self, new_val: <B3 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for funct3.

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

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

#Errors

If the given value is out of bounds for funct3.

pub fn set_funct3(&mut self, new_val: <B3 as Specifier>::InOut)

Sets the value of funct3 to the given value.

#Panics

If the given value is out of bounds for funct3.

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

Sets the value of funct3 to the given value.

#Errors

If the given value is out of bounds for funct3.

Trait Implementations

impl CheckFillsUnalignedBits for CBIType

type CheckType = [(); 1]

impl Clone for CBIType

fn clone(&self) -> CBIType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CBIType

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

Formats the value using the given formatter.

impl PartialEq for CBIType

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

impl Eq for CBIType

impl StructuralPartialEq for CBIType