pub enum BitDomain<'a, O, T> where
O: BitOrder,
T: 'a + BitStore, {
Enclave {
head: BitIdx<T::Mem>,
body: &'a BitSlice<O, T>,
tail: BitTail<T::Mem>,
},
Region {
head: &'a BitSlice<O, T>,
body: &'a BitSlice<O, T::Mem>,
tail: &'a BitSlice<O, T>,
},
}
Expand description
Granular representation of the memory region containing a
BitSlice
.
BitSlice
regions can be described in terms of edge and center
elements, where the edge elements retain the aliasing status of the
source BitSlice
handle, and the center elements are 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 subregion of memory that no
longer requires them for correct access.
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
provide references to the underlying memory elements. If you need
such access directly, use the Domain
or DomainMut
enums.
Lifetimes
'a
: The lifetime of the referent storage region.
Type Parameters
O
: The ordering type of the sourceBitSlice
handle.T
: The element type of the sourceBitSlice
handle, including aliasing markers.
Variants
Enclave
Fields
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 BitSlice<O, T>
The original BitSlice
used to create this bit-domain view.
Indicates that a BitSlice
is contained entirely in the
interior indices of a single memory element.
Region
Fields
head: &'a 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 BitSlice<O, T::Mem>
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.
Safety Exception
&BitSlice<O, T::Alias>
references have access to a
.set_aliased
method, which represents the only means in
bitvec
of writing to memory without an exclusive &mut
reference.
Construction of two such shared, aliasing, references over
the same data, then construction of a bit-domain view over
one of them and simultaneous writing through the other to
interior elements marked as unaliased, will cause the
bit-domain view to be undefined behavior. Do not combine
bit-domain views and .set_aliased
calls.
tail: &'a 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.
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.
Implementations
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
.
Trait Implementations
Auto Trait Implementations
impl<'a, O, T> RefUnwindSafe for BitDomain<'a, O, T> where
O: RefUnwindSafe,
T: RefUnwindSafe,
<T as BitStore>::Mem: RefUnwindSafe,
impl<'a, O, T> Send for BitDomain<'a, O, T> where
<T as BitStore>::Threadsafe: Sync,
<<T as BitStore>::Mem as BitStore>::Threadsafe: Sync,
impl<'a, O, T> Sync for BitDomain<'a, O, T> where
<T as BitStore>::Threadsafe: Sync,
<<T as BitStore>::Mem as BitStore>::Threadsafe: Sync,
impl<'a, O, T> UnwindSafe for BitDomain<'a, O, T> where
O: RefUnwindSafe,
T: RefUnwindSafe,
<T as BitStore>::Mem: UnwindSafe + RefUnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Causes self
to use its Binary
implementation when Debug
-formatted.
Causes self
to use its Display
implementation when
Debug
-formatted. Read more
Causes self
to use its LowerExp
implementation when
Debug
-formatted. Read more
Causes self
to use its LowerHex
implementation when
Debug
-formatted. Read more
Causes self
to use its Octal
implementation when Debug
-formatted.
Causes self
to use its Pointer
implementation when
Debug
-formatted. Read more
Causes self
to use its UpperExp
implementation when
Debug
-formatted. Read more
Causes self
to use its UpperHex
implementation when
Debug
-formatted. Read more
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
Pipes a dereference into a function that cannot normally be called in suffix position. Read more
Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more
Provides immutable access to the reference for inspection.
Calls tap_ref
in debug builds, and does nothing in release builds.
Provides mutable access to the reference for modification.
Calls tap_ref_mut
in debug builds, and does nothing in release builds.
Provides immutable access to the borrow for inspection. Read more
Calls tap_borrow
in debug builds, and does nothing in release builds.
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Provides mutable access to the borrow for modification.
Immutably dereferences self
for inspection.
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Calls tap_deref
in debug builds, and does nothing in release builds.
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Mutably dereferences self
for modification.