Struct CBType

Source
pub struct CBType { /* private fields */ }

Implementations§

Source§

impl CBType

Source

pub const fn new() -> Self

Returns an instance with zero initialized data.

Source§

impl CBType

Source

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.

Source

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

Converts the given bytes directly into the bitfield struct.

Source§

impl CBType

Source

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

Returns the value of op.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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

Returns the value of imm5.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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

Returns the value of imm2_1.

Source

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

Returns the value of imm2_1.

#Errors

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

Source

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

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

#Panics

If the given value is out of bounds for imm2_1.

Source

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

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

#Errors

If the given value is out of bounds for imm2_1.

Source

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

Sets the value of imm2_1 to the given value.

#Panics

If the given value is out of bounds for imm2_1.

Source

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

Sets the value of imm2_1 to the given value.

#Errors

If the given value is out of bounds for imm2_1.

Source

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

Returns the value of imm7_6.

Source

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

Returns the value of imm7_6.

#Errors

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

Source

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

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

#Panics

If the given value is out of bounds for imm7_6.

Source

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

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

#Errors

If the given value is out of bounds for imm7_6.

Source

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

Sets the value of imm7_6 to the given value.

#Panics

If the given value is out of bounds for imm7_6.

Source

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

Sets the value of imm7_6 to the given value.

#Errors

If the given value is out of bounds for imm7_6.

Source

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

Returns the value of rd_or_rs1.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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

Returns the value of imm4_3.

Source

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

Returns the value of imm4_3.

#Errors

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

Source

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

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

#Panics

If the given value is out of bounds for imm4_3.

Source

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

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

#Errors

If the given value is out of bounds for imm4_3.

Source

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

Sets the value of imm4_3 to the given value.

#Panics

If the given value is out of bounds for imm4_3.

Source

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

Sets the value of imm4_3 to the given value.

#Errors

If the given value is out of bounds for imm4_3.

Source

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

Returns the value of imm8.

Source

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

Returns the value of imm8.

#Errors

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

Source

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

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

#Panics

If the given value is out of bounds for imm8.

Source

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

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

#Errors

If the given value is out of bounds for imm8.

Source

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

Sets the value of imm8 to the given value.

#Panics

If the given value is out of bounds for imm8.

Source

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

Sets the value of imm8 to the given value.

#Errors

If the given value is out of bounds for imm8.

Source

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

Returns the value of funct3.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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§

Source§

impl CheckFillsUnalignedBits for CBType

Source§

impl Clone for CBType

Source§

fn clone(&self) -> CBType

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CBType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for CBType

Source§

fn eq(&self, other: &CBType) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for CBType

Source§

impl Eq for CBType

Source§

impl StructuralPartialEq for CBType

Auto Trait Implementations§

§

impl Freeze for CBType

§

impl RefUnwindSafe for CBType

§

impl Send for CBType

§

impl Sync for CBType

§

impl Unpin for CBType

§

impl UnwindSafe for CBType

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.