Struct SType

pub struct SType { /* private fields */ }

Implementations

impl SType

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl SType

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 SType

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 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 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.

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

Returns the value of rs1.

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

Returns the value of rs1.

#Errors

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

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

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

#Panics

If the given value is out of bounds for rs1.

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

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

#Errors

If the given value is out of bounds for rs1.

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

Sets the value of rs1 to the given value.

#Panics

If the given value is out of bounds for rs1.

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

Sets the value of rs1 to the given value.

#Errors

If the given value is out of bounds for rs1.

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

Returns the value of rs2.

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

Returns the value of rs2.

#Errors

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

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

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

#Panics

If the given value is out of bounds for rs2.

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

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

#Errors

If the given value is out of bounds for rs2.

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

Sets the value of rs2 to the given value.

#Panics

If the given value is out of bounds for rs2.

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

Sets the value of rs2 to the given value.

#Errors

If the given value is out of bounds for rs2.

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

Returns the value of imm11_5.

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

Returns the value of imm11_5.

#Errors

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

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

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

#Panics

If the given value is out of bounds for imm11_5.

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

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

#Errors

If the given value is out of bounds for imm11_5.

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

Sets the value of imm11_5 to the given value.

#Panics

If the given value is out of bounds for imm11_5.

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

Sets the value of imm11_5 to the given value.

#Errors

If the given value is out of bounds for imm11_5.

Trait Implementations

impl CheckFillsUnalignedBits for SType

type CheckType = [(); 1]

impl Clone for SType

fn clone(&self) -> SType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SType

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

Formats the value using the given formatter.

impl PartialEq for SType

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

impl Eq for SType

impl StructuralPartialEq for SType