Enum bitvec::domain::BitDomainMut [−][src]
pub enum BitDomainMut<'a, O, T> where
O: BitOrder,
T: BitStore, { Enclave { head: BitIdx<T::Mem>, body: &'a mut BitSlice<O, T>, tail: BitTail<T::Mem>, }, Region { head: &'a mut BitSlice<O, T>, body: &'a mut BitSlice<O, T::Unalias>, tail: &'a mut BitSlice<O, T>, }, }
Granular representation of the memory region containing a
BitSlice.
BitSlice regions can be described in terms of edge and center
partitions, where the edge partitions must retain the aliasing
status of the source BitSlice handle, and the center partition is
known to be completely unaliased by any other view. This property
allows any BitSlice handle to be decomposed into smaller regions,
and safely remove any aliasing markers from the center partition
that no longer requires such safeguarding.
This enum acts like the .split* methods in that it only subdivides
the source BitSlice into smaller BitSlices, and makes
appropriate modifications to the aliasing markers.
It does not add any aliasing markers: if the slice is marked as aliased, then the edge partitions will retain that marker, and if it is not, then the edge partitions do not need it.
This does not provide references to the underlying memory buffer. If
you need such direct access, use the Domain or DomainMut
enums.
Lifetimes
'a: The lifetime of the referent storage region.
Type Parameters
O: The ordering type of the sourceBitSlicehandle.T: The register type of the sourceBitSlicehandle, including any aliasing markers.
Aliasing Awareness
This enum does not grant access to memory outside the scope of the
original BitSlice handle, and so does not need to modfiy any
aliasing conditions.
Variants
Indicates that a BitSlice is contained entirely in the
interior indices of a single memory register.
Show fields
Fields of Enclave
head: BitIdx<T::Mem>The start index of the BitSlice.
This is not likely to be useful information, but is retained for structural similarity with the rest of the module.
body: &'a mut BitSlice<O, T>The original BitSlice used to create this bit-domain
view.
tail: BitTail<T::Mem>The end index of the BitSlice.
This is not likely to be useful information, but is retained for structural similarity with the rest of the module.
Indicates that a BitSlice region touches at least one edge
index of any number of elements.
This contains two BitSlices representing the
partially-occupied edge elements, with their original aliasing
marker, and one BitSlice representing the fully-occupied
interior elements, marked as unaliased.
Show fields
Fields of Region
head: &'a mut BitSlice<O, T>Any bits that partially-fill the base element of the slice region.
This does not modify its aliasing status, as it will already be appropriately marked before constructing this view.
body: &'a mut BitSlice<O, T::Unalias>Any bits inside elements that the source BitSlice
completely covers.
This is marked as unaliased, because it is statically
impossible for any other handle to have write access to the
region it covers. As such, a BitSlice that was marked as
entirely aliased, but contains interior unaliased elements,
can safely remove its aliasing protections.
tail: &'a mut BitSlice<O, T>Any bits that partially fill the last element of the slice region.
This does not modify its aliasing status, as it will already be appropriately marked before constructing this view.
Implementations
impl<'a, O, T> BitDomainMut<'a, O, T> where
O: BitOrder,
T: BitStore, [src]
impl<'a, O, T> BitDomainMut<'a, O, T> where
O: BitOrder,
T: BitStore, [src]pub fn enclave(
self
) -> Option<(BitIdx<T::Mem>, &'a mut BitSlice<O, T>, BitTail<T::Mem>)>[src]
self
) -> Option<(BitIdx<T::Mem>, &'a mut BitSlice<O, T>, BitTail<T::Mem>)>
Attempts to view the domain as an enclave variant.
Parameters
self
Returns
If self is the Enclave variant, this returns Some of the
enclave fields, as a tuple. Otherwise, it returns None.
pub fn region(
self
) -> Option<(&'a mut BitSlice<O, T>, &'a mut BitSlice<O, T::Unalias>, &'a mut BitSlice<O, T>)>[src]
self
) -> Option<(&'a mut BitSlice<O, T>, &'a mut BitSlice<O, T::Unalias>, &'a mut BitSlice<O, T>)>
Attempts to view the domain as a region variant.
Parameters
self
Returns
If self is the Region variant, this returns Some of the
region fields, as a tuple. Otherwise, it returns None.
Trait Implementations
Auto Trait Implementations
impl<'a, O, T> RefUnwindSafe for BitDomainMut<'a, O, T> where
O: RefUnwindSafe,
T: RefUnwindSafe,
<T as BitStore>::Mem: RefUnwindSafe,
<T as BitStore>::Unalias: RefUnwindSafe,
O: RefUnwindSafe,
T: RefUnwindSafe,
<T as BitStore>::Mem: RefUnwindSafe,
<T as BitStore>::Unalias: RefUnwindSafe,
impl<'a, O, T> Send for BitDomainMut<'a, O, T> where
T: Sync,
<T as BitStore>::Unalias: Sync,
T: Sync,
<T as BitStore>::Unalias: Sync,
impl<'a, O, T> Sync for BitDomainMut<'a, O, T> where
T: Sync,
<T as BitStore>::Unalias: Sync,
T: Sync,
<T as BitStore>::Unalias: Sync,
impl<'a, O, T> Unpin for BitDomainMut<'a, O, T>
impl<'a, O, T> !UnwindSafe for BitDomainMut<'a, O, T>
Blanket Implementations
impl<T> FmtForward for T[src]
impl<T> FmtForward for T[src]pub fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary, [src]
Self: Binary,
pub fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display, [src]
Self: Display,
pub fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp, [src]
Self: LowerExp,
pub fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex, [src]
Self: LowerHex,
pub fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal, [src]
Self: Octal,
pub fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer, [src]
Self: Pointer,
pub fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp, [src]
Self: UpperExp,
pub fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex, [src]
Self: UpperHex,
impl<T> Pipe for T where
T: ?Sized, [src]
impl<T> Pipe for T where
T: ?Sized, [src]pub fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R[src]
pub fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a, [src]
R: 'a,
pub fn pipe_ref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self) -> R
) -> R where
R: 'a, [src]
&'a mut self,
func: impl FnOnce(&'a mut Self) -> R
) -> R where
R: 'a,
pub fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
R: 'a,
B: 'a + ?Sized, [src]
Self: Borrow<B>,
R: 'a,
B: 'a + ?Sized,
pub fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
R: 'a,
B: 'a + ?Sized, [src]
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
R: 'a,
B: 'a + ?Sized,
pub fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
R: 'a,
U: 'a + ?Sized, [src]
Self: AsRef<U>,
R: 'a,
U: 'a + ?Sized,
pub fn pipe_as_mut<'a, U, R>(
&'a mut self,
func: impl FnOnce(&'a mut U) -> R
) -> R where
Self: AsMut<U>,
R: 'a,
U: 'a + ?Sized, [src]
&'a mut self,
func: impl FnOnce(&'a mut U) -> R
) -> R where
Self: AsMut<U>,
R: 'a,
U: 'a + ?Sized,
pub fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a, [src]
Self: Deref<Target = T>,
T: 'a + ?Sized,
R: 'a,
pub fn pipe_deref_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
R: 'a, [src]
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: DerefMut<Target = T> + Deref,
T: 'a + ?Sized,
R: 'a,
impl<T> PipeAsRef for T[src]
impl<T> PipeAsRef for T[src]pub fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a, [src]
Self: AsRef<T>,
T: 'a,
R: 'a,
pub fn pipe_as_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: AsMut<T>,
T: 'a,
R: 'a, [src]
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: AsMut<T>,
T: 'a,
R: 'a,
impl<T> PipeBorrow for T[src]
impl<T> PipeBorrow for T[src]pub fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a, [src]
Self: Borrow<T>,
T: 'a,
R: 'a,
pub fn pipe_borrow_mut<'a, T, R>(
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
T: 'a,
R: 'a, [src]
&'a mut self,
func: impl FnOnce(&'a mut T) -> R
) -> R where
Self: BorrowMut<T>,
T: 'a,
R: 'a,
impl<T> PipeDeref for T[src]
impl<T> PipeDeref for T[src]pub fn pipe_deref<'a, R>(
&'a self,
func: impl FnOnce(&'a Self::Target) -> R
) -> R where
Self: Deref,
R: 'a, [src]
&'a self,
func: impl FnOnce(&'a Self::Target) -> R
) -> R where
Self: Deref,
R: 'a,
pub fn pipe_deref_mut<'a, R>(
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a, [src]
&'a mut self,
func: impl FnOnce(&'a mut Self::Target) -> R
) -> R where
Self: DerefMut,
R: 'a,
impl<T> Tap for T[src]
impl<T> Tap for T[src]pub fn tap(self, func: impl FnOnce(&Self)) -> Self[src]
pub fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self[src]
pub fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized, [src]
Self: Borrow<B>,
B: ?Sized,
pub fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized, [src]
Self: BorrowMut<B>,
B: ?Sized,
pub fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized, [src]
Self: AsRef<R>,
R: ?Sized,
pub fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized, [src]
Self: AsMut<R>,
R: ?Sized,
pub fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized, [src]
Self: Deref<Target = T>,
T: ?Sized,
pub fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized, [src]
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
pub fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self[src]
pub fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self[src]
pub fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self where
Self: Borrow<B>,
B: ?Sized, [src]
Self: Borrow<B>,
B: ?Sized,
pub fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self where
Self: BorrowMut<B>,
B: ?Sized, [src]
Self: BorrowMut<B>,
B: ?Sized,
pub fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self where
Self: AsRef<R>,
R: ?Sized, [src]
Self: AsRef<R>,
R: ?Sized,
pub fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self where
Self: AsMut<R>,
R: ?Sized, [src]
Self: AsMut<R>,
R: ?Sized,
pub fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self where
Self: Deref<Target = T>,
T: ?Sized, [src]
Self: Deref<Target = T>,
T: ?Sized,
pub fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self where
Self: DerefMut<Target = T> + Deref,
T: ?Sized, [src]
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
impl<T> Tap for T[src]
impl<T> Tap for T[src]pub fn tap<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R, [src]
F: FnOnce(&Self) -> R,
pub fn tap_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&Self) -> R, [src]
F: FnOnce(&Self) -> R,
pub fn tap_mut<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R, [src]
F: FnOnce(&mut Self) -> R,
pub fn tap_mut_dbg<F, R>(self, func: F) -> Self where
F: FnOnce(&mut Self) -> R, [src]
F: FnOnce(&mut Self) -> R,
impl<T, U> TapAsRef<U> for T where
U: ?Sized, [src]
impl<T, U> TapAsRef<U> for T where
U: ?Sized, [src]pub fn tap_ref<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R, [src]
Self: AsRef<T>,
F: FnOnce(&T) -> R,
pub fn tap_ref_dbg<F, R>(self, func: F) -> Self where
Self: AsRef<T>,
F: FnOnce(&T) -> R, [src]
Self: AsRef<T>,
F: FnOnce(&T) -> R,
pub fn tap_ref_mut<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R, [src]
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
pub fn tap_ref_mut_dbg<F, R>(self, func: F) -> Self where
Self: AsMut<T>,
F: FnOnce(&mut T) -> R, [src]
Self: AsMut<T>,
F: FnOnce(&mut T) -> R,
impl<T, U> TapBorrow<U> for T where
U: ?Sized, [src]
impl<T, U> TapBorrow<U> for T where
U: ?Sized, [src]pub fn tap_borrow<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R, [src]
Self: Borrow<T>,
F: FnOnce(&T) -> R,
pub fn tap_borrow_dbg<F, R>(self, func: F) -> Self where
Self: Borrow<T>,
F: FnOnce(&T) -> R, [src]
Self: Borrow<T>,
F: FnOnce(&T) -> R,
pub fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R, [src]
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
pub fn tap_borrow_mut_dbg<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R, [src]
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
impl<T> TapDeref for T[src]
impl<T> TapDeref for T[src]pub fn tap_deref<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R, [src]
Self: Deref,
F: FnOnce(&Self::Target) -> R,
pub fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R, [src]
Self: Deref,
F: FnOnce(&Self::Target) -> R,
pub fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R, [src]
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
pub fn tap_deref_mut_dbg<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R, [src]
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,