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 the BitSlice 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§

source§

impl<'a, M, T, O> PartialElement<'a, M, T, O>where M: Mutability, T: 'a + BitStore, O: BitOrder,

source

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.

source

pub fn head(&self) -> BitIdx<T::Mem>

Gets the starting index of the live bits in the element.

source

pub fn tail(&self) -> BitEnd<T::Mem>

Gets the ending index of the live bits in the element.

source

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.

source

pub fn mask(&self) -> BitMask<T::Mem>

Gets the bit-mask over all accessible bits.

source

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.

source§

impl<'a, T, O> PartialElement<'a, Mut, T, O>where T: BitStore, O: BitOrder, Address<Mut, T>: Referential<'a>,

source

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.

source

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.

source

pub fn clear(&mut self) -> T::Mem

Clears all bits governed by the partial-element to 0.

Returns

The previous value of the governed bits.

source

pub fn set(&mut self) -> T::Mem

Sets all bits governed by the partial-element to 1.

Returns

The previous value of the governed bits.

source§

impl<'a, M, T, O> PartialElement<'a, M, T, O>where M: Mutability, O: BitOrder, T: 'a + BitStore + Radium,

source

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§

source§

impl<'a, T, O> Clone for PartialElement<'a, Const, T, O>where T: BitStore, O: BitOrder, Address<Const, T>: Referential<'a>,

source§

fn clone(&self) -> Self

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<'a, M, T, O> Debug for PartialElement<'a, M, T, O>where M: Mutability, T: 'a + BitStore, O: BitOrder,

source§

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

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

impl<'a, M, T, O> Hash for PartialElement<'a, M, T, O>where M: Mutability, T: 'a + BitStore, O: BitOrder,

source§

fn hash<H>(&self, hasher: &mut H)where H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

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§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Conv for T

source§

fn conv<T>(self) -> Twhere Self: Into<T>,

Converts self into T using Into<T>. Read more
source§

impl<T> FmtForward for T

source§

fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
source§

fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
source§

fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
source§

fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
source§

fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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 Twhere 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> Pipe for Twhere T: ?Sized,

source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> Rwhere Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> Rwhere Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
source§

impl<T> Tap for T

source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> ToOwned for Twhere T: Clone,

§

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> TryConv for T

source§

fn try_conv<T>(self) -> Result<T, Self::Error>where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.