Struct soa_derive_example::ParticleSlice

pub struct ParticleSlice<'a> {
    pub mass: &'a [f64],
    pub position: &'a [[f64; 3]],
    pub kind: &'a [usize],
    pub name: &'a [String],
}

A slice of Particle inside a ParticleVec .

Fields

mass: &'a [f64]

A slice of mass from a ParticleVec

position: &'a [[f64; 3]]

A slice of position from a ParticleVec

kind: &'a [usize]

A slice of kind from a ParticleVec

name: &'a [String]

A slice of name from a ParticleVec

Implementations

impl<'a> ParticleSlice<'a>

pub fn iter(&self) -> Iter<'_>

Get an iterator over the ParticleRef in this slice.

impl<'a> ParticleSlice<'a>

pub fn len(&self) -> usize

Similar to [Particle] ::len(), the length of all fields should be the same.

pub fn is_empty(&self) -> bool

Similar to [Particle] ::is_empty(), the length of all fields should be the same.

pub fn first(&self) -> Option<ParticleRef<'a>>

Similar to [Particle] ::first().

pub fn split_first(&self) -> Option<(ParticleRef<'a>, ParticleSlice<'a>)>

Similar to [Particle] ::split_first().

pub fn last(&self) -> Option<ParticleRef<'a>>

Similar to [Particle] ::last().

pub fn split_last(&self) -> Option<(ParticleRef<'a>, ParticleSlice<'a>)>

Similar to [Particle] ::split_last().

pub fn split_at(&self, mid: usize) -> (ParticleSlice<'a>, ParticleSlice<'a>)

Similar to [Particle] ::split_at().

pub fn get<'b, I>(&'b self, index: I) -> Option<I::RefOutput> where
    I: SoAIndex<ParticleSlice<'b>>,
    'a: 'b, 

Similar to [Particle] ::get().

pub unsafe fn get_unchecked<'b, I>(&'b self, index: I) -> I::RefOutput where
    I: SoAIndex<ParticleSlice<'b>>,
    'a: 'b, 

Similar to [Particle] ::get_unchecked().

pub fn index<'b, I>(&'b self, index: I) -> I::RefOutput where
    I: SoAIndex<ParticleSlice<'b>>,
    'a: 'b, 

Similar to std::ops::Index trait on [Particle] . This is required because we cannot implement std::ops::Index directly since it requires returning a reference.

pub fn reborrow<'b>(&'b self) -> ParticleSlice<'b> where
    'a: 'b, 

Reborrows the slices in a narrower lifetime

pub fn as_ptr(&self) -> ParticlePtr

Similar to [Particle] ::as_ptr().

pub unsafe fn from_raw_parts<'b>(
    data: ParticlePtr,
    len: usize
) -> ParticleSlice<'b>

Similar to std::slice::from_raw_parts().

Trait Implementations

impl<'a> Clone for ParticleSlice<'a>

fn clone(&self) -> ParticleSlice<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ParticleSlice<'a>

impl<'a> Debug for ParticleSlice<'a>

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

Formats the value using the given formatter.

impl<'a> IntoIterator for ParticleSlice<'a>

type Item = ParticleRef<'a>

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'b> IntoIterator for &'a ParticleSlice<'b>

type Item = ParticleRef<'a>

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> PartialEq<ParticleSlice<'a>> for ParticleSlice<'a>

fn eq(&self, other: &ParticleSlice<'a>) -> bool

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

fn ne(&self, other: &ParticleSlice<'a>) -> bool

This method tests for !=.

impl<'a> SoAIndex<ParticleSlice<'a>> for usize

type RefOutput = ParticleRef<'a>

The output for the non-mutable functions

fn get(self, slice: ParticleSlice<'a>) -> Option<Self::RefOutput>

Returns the reference output in this location if in bounds, None otherwise.

unsafe fn get_unchecked(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location without performing any bounds check.

fn index(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location. Panics if it is not in bounds.

impl<'a> SoAIndex<ParticleSlice<'a>> for Range<usize>

type RefOutput = ParticleSlice<'a>

The output for the non-mutable functions

fn get(self, slice: ParticleSlice<'a>) -> Option<Self::RefOutput>

Returns the reference output in this location if in bounds, None otherwise.

unsafe fn get_unchecked(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location without performing any bounds check.

fn index(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location. Panics if it is not in bounds.

impl<'a> SoAIndex<ParticleSlice<'a>> for RangeTo<usize>

type RefOutput = ParticleSlice<'a>

The output for the non-mutable functions

fn get(self, slice: ParticleSlice<'a>) -> Option<Self::RefOutput>

Returns the reference output in this location if in bounds, None otherwise.

unsafe fn get_unchecked(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location without performing any bounds check.

fn index(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location. Panics if it is not in bounds.

impl<'a> SoAIndex<ParticleSlice<'a>> for RangeFrom<usize>

type RefOutput = ParticleSlice<'a>

The output for the non-mutable functions

fn get(self, slice: ParticleSlice<'a>) -> Option<Self::RefOutput>

Returns the reference output in this location if in bounds, None otherwise.

unsafe fn get_unchecked(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location without performing any bounds check.

fn index(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location. Panics if it is not in bounds.

impl<'a> SoAIndex<ParticleSlice<'a>> for RangeFull

type RefOutput = ParticleSlice<'a>

The output for the non-mutable functions

fn get(self, slice: ParticleSlice<'a>) -> Option<Self::RefOutput>

Returns the reference output in this location if in bounds, None otherwise.

unsafe fn get_unchecked(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location without performing any bounds check.

fn index(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location. Panics if it is not in bounds.

impl<'a> SoAIndex<ParticleSlice<'a>> for RangeInclusive<usize>

type RefOutput = ParticleSlice<'a>

The output for the non-mutable functions

fn get(self, slice: ParticleSlice<'a>) -> Option<Self::RefOutput>

Returns the reference output in this location if in bounds, None otherwise.

unsafe fn get_unchecked(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location without performing any bounds check.

fn index(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location. Panics if it is not in bounds.

impl<'a> SoAIndex<ParticleSlice<'a>> for RangeToInclusive<usize>

type RefOutput = ParticleSlice<'a>

The output for the non-mutable functions

fn get(self, slice: ParticleSlice<'a>) -> Option<Self::RefOutput>

Returns the reference output in this location if in bounds, None otherwise.

unsafe fn get_unchecked(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location without performing any bounds check.

fn index(self, slice: ParticleSlice<'a>) -> Self::RefOutput

Returns the reference output in this location. Panics if it is not in bounds.

impl<'a> StructuralPartialEq for ParticleSlice<'a>