Struct bitvec::domain::PartialElement
source · [−]pub struct PartialElement<'a, M, T, O> where
M: Mutability,
T: 'a + BitStore,
O: BitOrder, { /* private fields */ }
Expand description
Partially-Owned Memory Element
This type is a guarded reference to memory that permits interacting with it as
an integer, but only allows views to the section of the integer that the
producing handle has permission to observe. Unlike the BitSafe
type family in
the access
module, it is not a transparent wrapper that can be used for
reference conversion; it is a “heavy reference” that carries the mask and
Type Parameters
T
: The type, including register width and alias information, of the bit-slice handle that created it.O
: This propagates the bit-ordering type used by theBitSlice
handle that created it.
Lifetime
This carries the lifetime of the bit-slice handle that created it.
Usage
This structure is only created as part of the Domain
region descriptions,
and refers to partially-occupied edge elements. The underlying referent memory
can be read with .load_value()
or written with .store_value()
, and the
appropriate masking will be applied in order to restrict access to only the
permitted bits.
Implementations
sourceimpl<'a, M, T, O> PartialElement<'a, M, T, O> where
M: Mutability,
T: 'a + BitStore,
O: BitOrder,
impl<'a, M, T, O> PartialElement<'a, M, T, O> where
M: Mutability,
T: 'a + BitStore,
O: BitOrder,
sourcepub fn load_value(&self) -> T::Mem
pub fn load_value(&self) -> T::Mem
Fetches the value stored through self
and masks away extra bits.
Returns
A bit-map containing any bits set to 1
in the governed bits. All other
bits are cleared to 0
.
sourcepub fn bounds(&self) -> (BitIdx<T::Mem>, BitEnd<T::Mem>)
pub fn bounds(&self) -> (BitIdx<T::Mem>, BitEnd<T::Mem>)
Gets the semantic head and tail indices that constrain which bits of the referent element may be accessed.
sourcepub fn into_bitslice(self) -> Reference<'a, M, BitSlice<T, O>> where
Address<M, BitSlice<T, O>>: Referential<'a>,
pub fn into_bitslice(self) -> Reference<'a, M, BitSlice<T, O>> where
Address<M, BitSlice<T, O>>: Referential<'a>,
Converts the partial element into a bit-slice over its governed bits.
sourceimpl<'a, T, O> PartialElement<'a, Mut, T, O> where
T: BitStore,
O: BitOrder,
Address<Mut, T>: Referential<'a>,
impl<'a, T, O> PartialElement<'a, Mut, T, O> where
T: BitStore,
O: BitOrder,
Address<Mut, T>: Referential<'a>,
sourcepub fn store_value(&mut self, value: T::Mem) -> T::Mem
pub fn store_value(&mut self, value: T::Mem) -> T::Mem
Stores a value through self
after masking away extra bits.
Parameters
&mut self
value
: A bit-map which will be written into the governed bits. This is a bit-map store, not an integer store; the value will not be shifted into position and will only be masked directly against the bits that this partial-element governs.
Returns
The previous value of the governed bits.
sourcepub fn invert(&mut self) -> T::Mem
pub fn invert(&mut self) -> T::Mem
Inverts the value of each bit governed by the partial-element.
Returns
The previous value of the governed bits.
sourceimpl<'a, M, T, O> PartialElement<'a, M, T, O> where
M: Mutability,
O: BitOrder,
T: 'a + BitStore + Radium,
impl<'a, M, T, O> PartialElement<'a, M, T, O> where
M: Mutability,
O: BitOrder,
T: 'a + BitStore + Radium,
sourcepub fn store_value_aliased(&self, value: T::Mem) -> T::Mem
pub fn store_value_aliased(&self, value: T::Mem) -> T::Mem
Performs a store operation on a partial-element whose bits might be observed by another handle.
Trait Implementations
sourceimpl<'a, T, O> Clone for PartialElement<'a, Const, T, O> where
T: BitStore,
O: BitOrder,
Address<Const, T>: Referential<'a>,
impl<'a, T, O> Clone for PartialElement<'a, Const, T, O> where
T: BitStore,
O: BitOrder,
Address<Const, T>: Referential<'a>,
sourceimpl<'a, M, T, O> Debug for PartialElement<'a, M, T, O> where
M: Mutability,
T: 'a + BitStore,
O: BitOrder,
impl<'a, M, T, O> Debug for PartialElement<'a, M, T, O> where
M: Mutability,
T: 'a + BitStore,
O: BitOrder,
sourceimpl<'a, M, T, O> Hash for PartialElement<'a, M, T, O> where
M: Mutability,
T: 'a + BitStore,
O: BitOrder,
impl<'a, M, T, O> Hash for PartialElement<'a, M, T, O> where
M: Mutability,
T: 'a + BitStore,
O: BitOrder,
impl<T, O> Copy for PartialElement<'_, Const, T, O> where
T: BitStore,
O: BitOrder,
Auto Trait Implementations
impl<'a, M, T, O> RefUnwindSafe for PartialElement<'a, M, T, O> where
M: RefUnwindSafe,
O: RefUnwindSafe,
T: RefUnwindSafe,
<T as BitStore>::Access: RefUnwindSafe,
<T as BitStore>::Mem: RefUnwindSafe,
impl<'a, M, T, O> !Send for PartialElement<'a, M, T, O>
impl<'a, M, T, O> !Sync for PartialElement<'a, M, T, O>
impl<'a, M, T, O> Unpin for PartialElement<'a, M, T, O> where
M: Unpin,
O: Unpin,
impl<'a, M, T, O> UnwindSafe for PartialElement<'a, M, T, O> where
M: UnwindSafe,
O: UnwindSafe,
T: RefUnwindSafe,
<T as BitStore>::Access: RefUnwindSafe,
<T as BitStore>::Mem: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> FmtForward for T
impl<T> FmtForward for T
sourcefn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,
Causes self
to use its Binary
implementation when Debug
-formatted. Read more
sourcefn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,
Causes self
to use its Display
implementation when
Debug
-formatted. Read more
sourcefn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,
Causes self
to use its LowerExp
implementation when
Debug
-formatted. Read more
sourcefn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,
Causes self
to use its LowerHex
implementation when
Debug
-formatted. Read more
sourcefn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,
Causes self
to use its Octal
implementation when Debug
-formatted. Read more
sourcefn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,
Causes self
to use its Pointer
implementation when
Debug
-formatted. Read more
sourcefn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,
Causes self
to use its UpperExp
implementation when
Debug
-formatted. Read more
sourcefn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,
Causes self
to use its UpperHex
implementation when
Debug
-formatted. Read more
sourceimpl<T> Pipe for T where
T: ?Sized,
impl<T> Pipe for T where
T: ?Sized,
sourcefn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
Pipes by value. This is generally the method you want to use. Read more
sourcefn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,
Borrows self
and passes that borrow into the pipe function. Read more
sourcefn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,
Mutably borrows self
and passes that borrow into the pipe function. Read more
sourcefn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
Borrows self
, then passes self.borrow()
into the pipe function. Read more
sourcefn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
Mutably borrows self
, then passes self.borrow_mut()
into the pipe
function. Read more
sourcefn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
Borrows self
, then passes self.as_ref()
into the pipe function.
sourcefn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
Mutably borrows self
, then passes self.as_mut()
into the pipe
function. Read more
sourceimpl<T> Tap for T
impl<T> Tap for T
sourcefn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Immutable access to the Borrow<B>
of a value. Read more
sourcefn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Mutable access to the BorrowMut<B>
of a value. Read more
sourcefn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Immutable access to the AsRef<R>
view of a value. Read more
sourcefn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Mutable access to the AsMut<R>
view of a value. Read more
sourcefn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized,
Immutable access to the Deref::Target
of a value. Read more
sourcefn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Mutable access to the Deref::Target
of a value. Read more
sourcefn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls .tap()
only in debug builds, and is erased in release builds.
sourcefn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls .tap_mut()
only in debug builds, and is erased in release
builds. Read more
sourcefn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized,
Calls .tap_borrow()
only in debug builds, and is erased in release
builds. Read more
sourcefn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized,
Calls .tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read more
sourcefn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized,
Calls .tap_ref()
only in debug builds, and is erased in release
builds. Read more
sourcefn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized,
Calls .tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more