Struct RawGetter

pub struct RawGetter { /* private fields */ }

A raw getter for a container of items.

The getter basically provides RawGetter::get method for random access, but you can register sequential access function through RawGetter::with_iter. Then you can call RawGetter::iter for sequential access.

Sequential access would be way faster than random access due to its cache friendly access pattern, so it’s recommended to perfer it over random access as much as possible.

Implementations

impl RawGetter

pub const unsafe fn new( this: NonNull<u8>, len: usize, fn_get: unsafe fn(this: NonNull<u8>, index: usize) -> NonNull<u8>, ) -> Self

Creates a new RawGetter from raw parts.

• this - A pointer to a container.
• len - Number of items of the container.
• fn_get - A function that returns pointer to an item for an item index.

Safety

Caller must guarantee that the created getter must have valid access to the given pointer while it is in use.

pub const fn with_iter( self, fn_iter: unsafe fn(this: NonNull<u8>) -> FlatRawIter, ) -> Self

Registers the given function to the raw getter.

• fn_iter - A function pointer for generating sequential access iterator.

pub const fn len(&self) -> usize

Returns number of items in the associated container.

pub const fn is_empty(&self) -> bool

Returns true if the associated container is empty.

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

Returns a type-erased pointer to an item of the associated container.

pub unsafe fn get_unchecked(&self, index: usize) -> NonNull<u8>

Returns a type-erased pointer to an item of the associated container.

Safety

Undefined behavior if the given index is out of bounds.

pub fn iter(&self) -> FlatRawIter

Returns a sequential access iterator for the associated container.

Make sure that you have registered a function through RawGetter::with_iter.

Panics

Panics if iterator geneartion function have not registered yet.

pub fn ptr(&self) -> NonNull<u8>

Returns a type-erased pointer to the associated container.

Trait Implementations

impl Clone for RawGetter

fn clone(&self) -> RawGetter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RawGetter

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

Formats the value using the given formatter.

impl Copy for RawGetter