Struct pasture_core::containers::PointView

pub struct PointView<'a, 'b, B: BorrowedBuffer<'a>, T: PointType>
where
    'a: 'b,
{ /* private fields */ }

A strongly typed view over the point data of a buffer. This allows accessing the point data in the buffer using type T instead of only through raw memory (i.e. as &[u8]). This type makes no assumptions about the memory layout of the underlying buffer, so it only provides access to the point data by value. The PointView supports no type conversion, so T::layout() must match the PointLayout of the buffer. You cannot create instances of PointView directly but instead have to use BorrowedBuffer::view function and its variations, which perform the necessary type checks internally!

Lifetime bounds

Since the PointView borrows the buffer internally, and the buffer itself has a borrow lifetime, PointView stores two lifetimes so that it can borrow its buffer for a potentially shorter lifetime 'b than the lifetime 'a of the buffer itself.

Implementations

impl<'a, 'b, B: BorrowedBuffer<'a>, T: PointType> PointView<'a, 'b, B, T>

where 'a: 'b,

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

Access the point at index

Panics

If index is out of bounds

impl<'a, 'b, B: InterleavedBuffer<'a>, T: PointType> PointView<'a, 'b, B, T>

where 'a: 'b,

pub fn at_ref<'c>(&'c self, index: usize) -> &'c T

where 'b: 'c,

Access the point at index by reference

Lifetime bounds

Just as the PointView can borrow its underlying buffer for a shorter lifetime 'b than the lifetime 'a of the buffer, it should be possible to borrow a single point from a PointView for a shorter lifetime 'c than the lifetime 'b of the PointView, hence the additional lifetime bounds.

Panics

If index is out of bounds

pub fn iter<'c>(&'c self) -> PointIteratorByRef<'c, T>

where 'b: 'c,

Return an iterator over strongly typed point data by reference

Trait Implementations

impl<'a, 'b, B: Clone + BorrowedBuffer<'a>, T: Clone + PointType> Clone for PointView<'a, 'b, B, T>

where 'a: 'b,

fn clone(&self) -> PointView<'a, 'b, B, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, 'b, B: Debug + BorrowedBuffer<'a>, T: Debug + PointType> Debug for PointView<'a, 'b, B, T>

where 'a: 'b,

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

Formats the value using the given formatter.

impl<'a, 'b, B: BorrowedBuffer<'a> + 'a, T: PointType> IntoIterator for PointView<'a, 'b, B, T>

where 'a: 'b,

type Item = T

The type of the elements being iterated over.

type IntoIter = PointIteratorByValue<'a, 'b, T, B>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'b, 'c, 'd, B1: BorrowedBuffer<'a> + 'a, B2: BorrowedBuffer<'c> + 'c, T: PointType + PartialEq> PartialEq<PointView<'c, 'd, B2, T>> for PointView<'a, 'b, B1, T>

fn eq(&self, other: &PointView<'c, 'd, B2, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b, B: Copy + BorrowedBuffer<'a>, T: Copy + PointType> Copy for PointView<'a, 'b, B, T>

where 'a: 'b,

impl<'a, 'b, B: BorrowedBuffer<'a> + 'a, T: PointType + Eq> Eq for PointView<'a, 'b, B, T>