Struct bones_ecs::prelude::SchemaVecAccess

pub struct SchemaVecAccess<'a> { /* private fields */ }

Access helper for a SchemaVec.

Implementations

impl<'a> SchemaVecAccess<'a>

pub fn into_schema_ref(self) -> SchemaRef<'a>

Convert back to a SchemaRefMut

Methods from Deref<Target = &'a SchemaVec>

pub fn try_push<T>(&mut self, item: T) -> Result<(), SchemaMismatchError>

where T: HasSchema,

Push an item to the vec.

Errors

Errors if the schema of T doesn’t match the vec.

pub fn push<T>(&mut self, item: T)

where T: HasSchema,

Push an item to the vec.

Panics

Panics if the schema of T doesn’t match the vec.

pub fn try_push_box( &mut self, item: SchemaBox, ) -> Result<(), SchemaMismatchError>

Push the item into the end of the vector.

pub fn push_box(&mut self, item: SchemaBox)

Push the item into the end of the vector.

pub fn pop_box(&mut self) -> Option<SchemaBox>

Pop the last item off of the end of the vector.

pub fn try_pop<T>(&mut self) -> Result<Option<T>, SchemaMismatchError>

where T: HasSchema,

Pop an item off the vec.

Errors

Errors if the schema of T doesn’t match.

pub fn pop<T>(&mut self) -> Option<T>

where T: HasSchema,

Pop an item off the vec.

Panics

Panics if the schema of T doesn’t match.

pub fn try_get<T>(&self, idx: usize) -> Result<Option<&T>, SchemaMismatchError>

where T: HasSchema,

Get an item in the vec.

Errors

Errors if the schema doesn’t match.

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

where T: HasSchema,

Get an item in the vec.

Panics

Panics if the schema doesn’t match.

pub fn get_ref(&self, idx: usize) -> Option<SchemaRef<'_>>

Get the item with the given index.

pub fn try_get_mut<T>( &mut self, idx: usize, ) -> Result<Option<&mut T>, SchemaMismatchError>

where T: HasSchema,

Get an item in the vec.

Errors

Errors if the schema doesn’t match.

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

where T: HasSchema,

Get an item in the vec.

Panics

Panics if the schema doesn’t match.

pub fn get_ref_mut(&mut self, idx: usize) -> Option<SchemaRefMut<'_>>

Get an item with the given index.

pub fn len(&self) -> usize

Get the number of items in the vector.

pub fn is_empty(&self) -> bool

Returns true if the vector has zero items in it.

pub fn capacity(&self) -> usize

Get the capacity of the backing buffer.

pub fn schema(&self) -> &'static Schema

Get the schema of items in this SchemaVec.

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

Iterate over values in the vec

pub fn iter_mut(&mut self) -> SchemaVecIterMut<'_>

Iterate mutably over values in the vec

pub fn hash(&self) -> u64

Get the hash of this SchemaVec.

Panics

Panics if the inner type doesn’t implement hash.

pub fn remove(&mut self, index: usize) -> SchemaBox

Remove and return the element at position index within the vector, shifting all elements after it to the left.

Panics

Panics if index is out of bounds.

pub fn clear(&mut self)

Clears the vector, removing all values.

pub fn truncate(&mut self, len: usize)

Shortens the vector, keeping the first len elements and dropping the rest.

If len is greater than the vector’s current length, this has no effect.

Trait Implementations

impl<'a> Clone for SchemaVecAccess<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Deref for SchemaVecAccess<'a>

type Target = &'a SchemaVec

The resulting type after dereferencing.

fn deref(&self) -> &<SchemaVecAccess<'a> as Deref>::Target

Dereferences the value.

impl<'a> DerefMut for SchemaVecAccess<'a>

fn deref_mut(&mut self) -> &mut <SchemaVecAccess<'a> as Deref>::Target

Mutably dereferences the value.

impl<'a> Copy for SchemaVecAccess<'a>