Struct Getter

pub struct Getter<'cont, T: 'cont> { /* private fields */ }

A getter that can be created from RawGetter with concrete type and lifetime.

This getter is useful when you have RawGetter and know what type the getter will return. You can create this getter from the RawGetter then use it as a get function of an associated container.

Implementations

impl<'cont, T> Getter<'cont, T>

pub unsafe fn from_raw(raw: RawGetter) -> Self

Creates a new Getter from the given RawGetter.

Safety

• The RawGetter must return pointers to type T.
• Lifetime defined by caller must be sufficient to the RawGetter.

pub fn into_raw(self) -> RawGetter

Converts the getter into RawGetter by unwrpping self.

pub fn len(&self) -> usize

Returns number of items in the associated container.

pub fn is_empty(&self) -> bool

Returns true is the associated container is empty.

pub fn get(&self, index: usize) -> Option<&T>

Returns a shared reference to a value at the given index in the associated container.

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

Returns a shared reference to a value at the given index in the associated container.

Safety

Undefined behavior if the given index is out of bounds.

pub fn iter(&self) -> FlatIter<'cont, T>

Returns a sequential access iterator of the associated container.

But if you created the iterator from a RawGetter without calling RawGetter::with_iter, this will panic.

Panics

Panics if iterator geneartion function have not registered yet.

pub fn par_iter(&self) -> ParFlatIter<'cont, T>

Returns a parallel iterator of the associated container.

But if you created the iterator from a RawGetter without calling RawGetter::with_iter, this will panic.

Panics

Panics if iterator geneartion function have not registered yet.

pub fn num_chunks(&self) -> usize

Returns number of chunks.

pub fn as_slice(&self, chunk_index: usize) -> &[T]

Retrieves a slice for the given chunk index.

If the given chunk index is out of bounds, empty slice is returned.

Trait Implementations

impl<'cont, T: Clone + 'cont> Clone for Getter<'cont, T>

fn clone(&self) -> Getter<'cont, T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'cont, T: Debug + 'cont> Debug for Getter<'cont, T>

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

Formats the value using the given formatter.

impl<'cont, T> IntoIterator for Getter<'cont, T>

type Item = &'cont T

The type of the elements being iterated over.

type IntoIter = FlatIter<'cont, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'cont, T: Send + Sync> IntoParallelIterator for Getter<'cont, T>

type Iter = ParFlatIter<'cont, T>

The parallel iterator type that will be created.

type Item = &'cont T

The type of item that the parallel iterator will produce.

fn into_par_iter(self) -> Self::Iter

Converts self into a parallel iterator.