Struct bones_lib::ecs::prelude::SchemaMap

pub struct SchemaMap { /* private fields */ }

Untyped schema-aware “HashMap”.

Implementations

impl SchemaMap

pub fn new( key_schema: &'static Schema, value_schema: &'static Schema, ) -> SchemaMap

Create a new map, with the given key and value schemas.

pub fn len(&self) -> usize

Get the number of entries in the map.

pub fn is_empty(&self) -> bool

Returns true if the map is empty.

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

Get the schema for the map keys.

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

Get the schema for the map values.

pub fn insert<K, V>(&mut self, key: K, value: V) -> Option<V>

where K: HasSchema, V: HasSchema,

Insert an item into the map.

Panics

Panics if the key or value schemas do not match the map’s.

pub fn try_insert<K, V>( &mut self, key: K, value: V, ) -> Result<Option<V>, SchemaMismatchError>

where K: HasSchema, V: HasSchema,

Insert an item into the map.

Errors

Errors if the key or value schemas do not match the map’s.

pub fn insert_box( &mut self, key: SchemaBox, value: SchemaBox, ) -> Option<SchemaBox>

Insert an untyped item into the map.

Panics

Panics if the key or value schemas do not match the map’s.

pub fn try_insert_box( &mut self, key: SchemaBox, value: SchemaBox, ) -> Result<Option<SchemaBox>, SchemaMismatchError>

Insert an untyped item into the map.

Errors

Errors if the key or value schemas do not match the map’s.

pub unsafe fn insert_box_unchecked( &mut self, key: SchemaBox, value: SchemaBox, ) -> Option<SchemaBox>

Safety

Key schema and value schema must match the map’s.

pub fn get<K, V>(&self, key: &K) -> Option<&V>

where K: HasSchema, V: HasSchema,

Get a value out of the map for the given key.

Panics

Panics if the schemas of the key and value don’t match the schemas of the map.

pub fn try_get<K, V>(&self, key: &K) -> Result<Option<&V>, SchemaMismatchError>

where K: HasSchema, V: HasSchema,

Get a value out of the map for the given key.

Errors

Errors if the schemas of the key and value don’t match the schemas of the map.

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

Get an untyped reference to an item in the map.

Panics

Panics if the schema of the key doesn’t match.

pub fn try_get_ref( &self, key: SchemaRef<'_>, ) -> Result<Option<SchemaRef<'_>>, SchemaMismatchError>

Get an untyped reference to an item in the map.

Errors

Errors if the schema of the key doesn’t match.

pub unsafe fn get_ref_unchecked( &self, key: SchemaRef<'_>, ) -> Option<SchemaRef<'_>>

Safety

The key’s schema must match this map’s key schema.

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

Get an untyped reference to an item in the map.

Panics

Panics if the schema of the key doesn’t match.

pub fn try_get_ref_mut( &mut self, key: SchemaRef<'_>, ) -> Result<Option<SchemaRefMut<'_>>, SchemaMismatchError>

Get an untyped reference to an item in the map.

Errors

Errors if the schema of the key doesn’t match.

pub unsafe fn get_ref_unchecked_mut( &mut self, key: SchemaRef<'_>, ) -> Option<SchemaRefMut<'_>>

Safety

The key’s schema must match this map’s key schema.

pub fn get_mut<K, V>(&mut self, key: &K) -> Option<&mut V>

where K: HasSchema, V: HasSchema,

Get a value out of the map for the given key.

Panics

Panics if the schemas of the key and value don’t match the schemas of the map.

pub fn try_get_mut<K, V>( &mut self, key: &K, ) -> Result<Option<&mut V>, SchemaMismatchError>

where K: HasSchema, V: HasSchema,

Get a value out of the map for the given key.

Errors

Errors if the schemas of the key and value don’t match the schemas of the map.

pub fn remove<K, V>(&mut self, key: &K) -> Option<V>

where K: HasSchema, V: HasSchema,

Remove an item.

Panics

Panics if the schemas of the key and value don’t match the map.

pub fn try_remove<K, V>( &mut self, key: &K, ) -> Result<Option<V>, SchemaMismatchError>

where K: HasSchema, V: HasSchema,

Remove an item.

Errors

Errors if the schemas of the key and value don’t match the map.

pub fn remove_box(&mut self, key: SchemaRef<'_>) -> Option<SchemaBox>

Untypededly remove an item.

Panics

Panics if the key schema does not match the map’s.

pub fn try_remove_box( &mut self, key: SchemaRef<'_>, ) -> Result<Option<SchemaBox>, SchemaMismatchError>

Untypededly remove an item.

Errors

Errors if the key schema does not match the map’s.

pub unsafe fn remove_unchecked( &mut self, key: SchemaRef<'_>, ) -> Option<SchemaBox>

Safety

The key schema must match the map’s.

pub fn into_smap<K, V>(self) -> SMap<K, V>

where K: HasSchema, V: HasSchema,

Convert into a typed SMap.

Panics

Panics if the schemas of K and V don’t match the SchemaMap.

pub fn try_into_smap<K, V>(self) -> Result<SMap<K, V>, SchemaMismatchError>

where K: HasSchema, V: HasSchema,

Convert into a typed SMap.

Errors

Errors if the schemas of K and V don’t match the SchemaMap.

impl SchemaMap

pub fn iter( &self, ) -> Map<Iter<'_, SchemaBox, SchemaBox>, for<'a> fn(_: (&'a SchemaBox, &'a SchemaBox)) -> (SchemaRef<'a>, SchemaRef<'a>)>

Iterate over entries in the map.

pub fn iter_mut( &mut self, ) -> Map<IterMut<'_, SchemaBox, SchemaBox>, for<'a> fn(_: (&'a SchemaBox, &'a mut SchemaBox)) -> (SchemaRef<'a>, SchemaRefMut<'a>)>

Iterate over entries in the map.

pub fn keys( &self, ) -> Map<Keys<'_, SchemaBox, SchemaBox>, for<'a> fn(_: &'a SchemaBox) -> SchemaRef<'a>>

Iterate over keys in the map.

pub fn values( &self, ) -> Map<Values<'_, SchemaBox, SchemaBox>, for<'a> fn(_: &'a SchemaBox) -> SchemaRef<'a>>

Iterate over values in the map.

pub fn values_mut( &mut self, ) -> Map<ValuesMut<'_, SchemaBox, SchemaBox>, for<'a> fn(_: &'a mut SchemaBox) -> SchemaRefMut<'a>>

Iterate over values in the map.

Trait Implementations

impl Clone for SchemaMap

fn clone(&self) -> SchemaMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaMap

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a SchemaMap

type Item = (SchemaRef<'a>, SchemaRef<'a>)

The type of the elements being iterated over.

type IntoIter = Map<Iter<'a, SchemaBox, SchemaBox>, for<'a> fn(_: (&'a SchemaBox, &'a SchemaBox)) -> (SchemaRef<'a>, SchemaRef<'a>)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a SchemaMap as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut SchemaMap

type Item = (SchemaRef<'a>, SchemaRefMut<'a>)

The type of the elements being iterated over.

type IntoIter = Map<IterMut<'a, SchemaBox, SchemaBox>, for<'a> fn(_: (&'a SchemaBox, &'a mut SchemaBox)) -> (SchemaRef<'a>, SchemaRefMut<'a>)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut SchemaMap as IntoIterator>::IntoIter

Creates an iterator from a value.