Struct ReadHandle

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

Available on non-crate feature allocator_api only.

The reader for a Stele

Implementations

impl<T> ReadHandle<T>

pub fn read(&self, idx: usize) -> &T

Reads the value at the given index

Panic

This function panics in debug if the given index is out of bounds. Since Index operates through this function, this same caveat also applies when indexing

pub fn try_read(&self, idx: usize) -> Option<&T>

Attempts to read the value at the index and returns Some if the value exists, and None otherwise

pub fn len(&self) -> usize

Returns the current length of the underlying Stele

Note: this is an optimistic operation and the length may be changing under you

pub fn is_empty(&self) -> bool

Returns the current length of the underlying Stele

Note: This is an optimistic operation as a write may happen between the operation returning and making use of the information provided but if this returns false it cannot return true in the future

pub fn iter(&self) -> RefIterator<'_, T>

Creates a RefIterator

This is primarily used to ensure the creation of a RefIterator when T is Copy

impl<T: Copy> ReadHandle<T>

pub fn get(&self, idx: usize) -> T

Get provides a way to get an owned copy of a value inside a Stele provided the T implements Copy

Panic

This function panics in debug if the given index is out of bounds

Trait Implementations

impl<T> Clone for ReadHandle<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ReadHandle<T>

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

Formats the value using the given formatter.

impl<T> From<&Arc<Stele<T>>> for ReadHandle<T>

fn from(h: &Arc<Stele<T>>) -> Self

Converts to this type from the input type.

impl<T> Index<usize> for ReadHandle<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T> IntoIterator for &'a ReadHandle<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = RefIterator<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Copy> IntoIterator for ReadHandle<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = CopyIterator<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> Send for ReadHandle<T>

where Stele<T>: Send + Sync,

impl<T> Sync for ReadHandle<T>

where Stele<T>: Send + Sync,