Struct flatdata::ArrayView

pub struct ArrayView<'a, T> where
    T: for<'b> Struct<'b>,  { /* fields omitted */ }

A read-only view on a contiguous sequence of flatdata structs of the same type T.

The sequence is written using Vector or ExternalVector. The former provides a method to create an ArrayView to it. Note that, that an array view does not hold the data itself.

An archive provides a getter for each vector resource, which returns an array view.

Examples

use flatdata::{ArrayView, Vector};

define_struct!(
    A,
    RefA,
    RefMutA,
    "no_schema",
    4,
    (x, set_x, u32, 0, 16),
    (y, set_y, u32, 16, 16)
);

let mut v: Vector<A> = Vector::with_len(1);
{
    let mut a = v.at_mut(0);
    a.set_x(1);
    a.set_y(2);
}

let view: ArrayView<_> = v.as_view();
let a = view.at(0);
assert_eq!(a.x(), 1);
assert_eq!(a.y(), 2);

Methods

impl<'a, T> ArrayView<'a, T> where     T: for<'b> Struct<'b>,

pub fn new(data: &'a [u8]) -> Self

Creates a new ArrayView to the data at the given address.

The returned array view does not own the data.

pub fn len(&self) -> usize

Number of elements in the array.

pub fn is_empty(&self) -> bool

Return true if the array is empty.

pub fn at(&self, index: usize) -> <T as Struct<'a>>::Item

Returns a read-only handle to the element in the array at position index.

Panics

Panics if index is greater than or equal to ArrayView::len().

pub fn slice<R: RangeBounds<usize>>(&self, range: R) -> Self

Slice this array view by a given range.

Panics

Panics if the range is outside of bounds of array view.

pub fn iter(&self) -> ArrayViewIter<'a, T>

Returns an iterator to the elements of the array.

pub fn as_bytes(&self) -> &[u8]

Returns a raw bytes representation of the underlying array data.

Trait Implementations

impl<'a, T> AsRef<[u8]> for ArrayView<'a, T> where     T: for<'b> Struct<'b>,

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<'a, T: Clone> Clone for ArrayView<'a, T> where     T: for<'b> Struct<'b>,

fn clone(&self) -> ArrayView<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for ArrayView<'a, T> where     T: for<'b> Struct<'b>,

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

Formats the value using the given formatter.