Struct bit_struct::GetSet

pub struct GetSet<'a, P, T, const START: usize, const STOP: usize> { /* private fields */ }

A struct which allows for getting/setting a given property

Implementations

impl<'a, P, T, const START: usize, const STOP: usize> GetSet<'a, P, T, START, STOP>

pub const fn start(&self) -> usize

The bit offset at which this GetSet instance starts

pub const fn stop(&self) -> usize

The bit offset at which this GetSet instance ends

impl<'a, P: Num + Bounded + ShlAssign<usize> + ShrAssign<usize> + BitCount, T, const START: usize, const STOP: usize> GetSet<'a, P, T, START, STOP>

pub fn new(parent: &'a mut P) -> Self

Create a new GetSet. This should be called from methods generated by the bit_struct macro

impl<'a, P: Num + Shl<usize, Output = P> + Shr<usize, Output = P> + ShlAssign<usize> + ShrAssign<usize> + Bounded + BitAnd<Output = P> + Copy + BitCount, T: ValidCheck<P>, const START: usize, const STOP: usize> GetSet<'a, P, T, START, STOP>

pub fn get(&self) -> T

Get the property this GetSet points at

pub fn is_valid(&self) -> bool

Returns true if the memory this GetSet points at is a valid representation of T

pub fn get_raw(&self) -> P

Get the raw bits being pointed at, without type conversion nor any form of validation

impl<'a, P, T, const START: usize, const STOP: usize> GetSet<'a, P, T, START, STOP>where
T: FieldStorage + BitsFitIn<P>,
P: Num + Shl<usize, Output = P> + Copy + BitOrAssign + BitXorAssign + BitAnd<Output = P> + ShlAssign<usize> + ShrAssign<usize> + PartialOrd + Bounded + Sized + BitCount,

pub fn set(&mut self, value: T)

Set the property in the slice being pointed to by this GetSet

pub unsafe fn set_raw(&mut self, value: P)

Set the field to a raw value.

Safety

value must be a valid representation of the field. i.e., core::mem::transmute between P and T must be defined.