Struct catalyst_entities::FragMap

pub struct FragMap<T> { /* private fields */ }

Think of it as paralell Vector. Its contents can be accessed by FragRef and FragSlice. It can produce valid FragRefs that are initially mutable and thread local, and later can be promoted to shared and immutable. The access complexity is O(1) but involves double indirection. This structure does bound checks of each access.

Structure is designed to be sent between main and worker thread, worker thread can push new items and main thread commits them to the FragBase and pulls updates from it.

Implementations

impl<T> FragMap<T>

pub fn push(&mut self, value: T) -> FragRef<T>

Returned FragRef is initially mutable and thread local, after calling commit it will be promoted to shared and immutable.

pub fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) -> FragSlice<T>where I::IntoIter: ExactSizeIterator,

Analogous to push but handles sequences.

pub fn commit(&mut self, base: &mut FragBase<T>)

Freezes the thread local data and makes it shared.

pub fn commit_unique(self, base: &mut FragBase<T>)

Freezes the thread local data and makes it shared. Consuming version avoids cloning.

pub fn pull(&mut self, base: &FragBase<T>)

Pulls updates from possibli commited by other FragMaps.

pub fn indexed( &self, slice: FragSlice<T> ) -> impl Iterator<Item = (FragRef<T>, &T)> + ExactSizeIterator + DoubleEndedIteratorwhere T: NoInteriorMutability,

Returns iterator over slice items along with their FragRef.

pub fn next(&self) -> FragRef<T>

Returns next FragRef that will be returned by push.

pub unsafe fn get_unchecked(&self, index: FragRef<T>) -> &T

Safety

The caller must ensure reference is in range of valid memory.

pub unsafe fn gen_unchecked_slice(&self, slice: FragSlice<T>) -> &[T]

Safety

Ensure slice is in range of valid memory.

pub unsafe fn get_unchacked_mut(&mut self, index: FragRef<T>) -> &mut T

Safety

Ensure slice is not out of bounds and does not capture frozen element.

pub unsafe fn gen_unchecked_slice_mut( &mut self, slice: FragSlice<T> ) -> &mut [T]

Safety

Ensure slice is not out of bounds and does not capture frozen elements.

Trait Implementations

impl<T: NoInteriorMutability> Index<FragRef<T>> for FragMap<T>

type Output = T

The returned type after indexing.

fn index(&self, index: FragRef<T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T: NoInteriorMutability> Index<FragSlice<T>> for FragMap<T>

type Output = [T]

The returned type after indexing.

fn index(&self, index: FragSlice<T>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T: NoInteriorMutability> IndexMut<FragRef<T>> for FragMap<T>

fn index_mut(&mut self, index: FragRef<T>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T: NoInteriorMutability> IndexMut<FragSlice<T>> for FragMap<T>

fn index_mut(&mut self, index: FragSlice<T>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.