Struct Drain

pub struct Drain<'a, T: Component> {
    pub data: &'a mut MaskedStorage<T>,
}

A draining storage wrapper which has a Join implementation that removes the components.

Fields

data: &'a mut MaskedStorage<T>

The masked storage

Trait Implementations

impl<'a, T> Join for Drain<'a, T>

where T: Component,

type Mask = BitSet

Type of joined bit mask.

type Type = T

Type of joined components.

type Value = &'a mut MaskedStorage<T>

Type of joined storages.

unsafe fn open(self) -> (Self::Mask, Self::Value)

Open this join by returning the mask and the storages.

unsafe fn get(value: &mut Self::Value, id: Index) -> T

Get a joined component value by a given index.

fn join(self) -> JoinIter<Self>

where Self: Sized,

Create a joined iterator over the contents.

fn maybe(self) -> MaybeJoin<Self>

where Self: Sized,

Returns a Join-able structure that yields all indices, returning None for all missing elements and Some(T) for found elements.

fn is_unconstrained() -> bool

If this Join typically returns all indices in the mask, then iterating over only it or combined with other joins that are also dangerous will cause the JoinIter/ParJoin to go through all indices which is usually not what is wanted and will kill performance.