Struct froggy::Storage

pub struct Storage<T> { /* fields omitted */ }

Component storage type. Manages the components and allows for efficient processing. See also: Pointer

Examples

let mut storage = Storage::new();
// add component to storage
let pointer = storage.create(1u32);
// change component by pointer
storage[&pointer] = 30;

Methods

impl<T> Storage<T>

fn new() -> Storage<T>

Create a new empty storage.

fn with_capacity(capacity: usize) -> Storage<T>

Create a new empty storage with specified capacity.

fn sync_pending(&mut self)

Synchronize for all the pending updates. It will update all reference counters in Storage, so iter_alive and iter_alive_mut will return actual information.

Use this function only if necessary, because it needs to block Storage.

fn iter(&self) -> Iter<T>

Iterate all components in this storage that are still referenced from outside.

Attention

Information about live components is updated not for all changes, but only when you explicitly call sync_pending. It means, you can get wrong results when calling this function before updating pending.

fn iter_all(&self) -> Iter<T>

Iterate all components that are stored, even if not referenced. This can be faster than the regular iter for the lack of refcount checks.

fn iter_mut(&mut self) -> IterMut<T>

Iterate all components in this storage that are still referenced from outside, mutably.

Attention

Information about live components is updated not for all changes, but only when you explicitly call sync_pending. It means, you can get wrong results when calling this function before updating pending.

fn iter_all_mut(&mut self) -> IterMut<T>

Iterate all components that are stored, even if not referenced, mutably. This can be faster than the regular iter_mut for the lack of refcount checks.

fn pin(&self, item: &Item<T>) -> Pointer<T>

Pin an iterated item with a newly created Pointer.

fn split(&mut self, pointer: &Pointer<T>) -> (Slice<T>, &mut T, Slice<T>)

Split the storage according to the provided pointer, returning the (left slice, pointed data, right slice) triple, where: left slice contains all the elements that would be iterated prior to the given one, right slice contains all the elements that would be iterated after the given one

fn cursor(&mut self) -> Cursor<T>

Produce a streaming mutable iterator over components that are still referenced.

Attention

Information about live components is updated not for all changes, but only when you explicitly call sync_pending. It means, you can get wrong results when calling this function before updating pending.

fn cursor_end(&mut self) -> Cursor<T>

Returns a cursor to the end of the storage, for backwards streaming iteration.

fn create(&mut self, value: T) -> Pointer<T>

Add a new component to the storage, returning the Pointer to it.

Trait Implementations

impl<T: Debug> Debug for Storage<T>

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

Formats the value using the given formatter.

impl<'a, T> Index<&'a Pointer<T>> for Storage<T>

type Output = T

The returned type after indexing.

fn index(&self, pointer: &'a Pointer<T>) -> &T

Performs the indexing (container[index]) operation.

impl<'a, T> IndexMut<&'a Pointer<T>> for Storage<T>

fn index_mut(&mut self, pointer: &'a Pointer<T>) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T> FromIterator<T> for Storage<T>

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = T>, 

Creates a value from an iterator.

impl<'a, T> IntoIterator for &'a Storage<T>

type Item = Item<'a, T>

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut Storage<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> Default for Storage<T>

fn default() -> Self

Returns the "default value" for a type.