Struct specs::prelude::BitSet
[−]
[src]
pub struct BitSet { /* fields omitted */ }
A BitSet
is a simple set designed to track entity indices for which
a certain component exists. It does not track the Generation
of the
entities that it contains.
Note, a BitSet
is limited by design to only 1,048,576
indices.
Adding beyond this limit will cause the BitSet
to panic.
Methods
impl BitSet
[src]
pub fn new() -> BitSet
[src]
Creates an empty BitSet
.
pub fn with_capacity(max: u32) -> BitSet
[src]
Creates an empty BitSet
, preallocated for up to max
indices.
pub fn add(&mut self, id: u32) -> bool
[src]
Adds id
to the BitSet
. Returns true
if the value was
already in the set.
pub fn remove(&mut self, id: u32) -> bool
[src]
Removes id
from the set, returns true
if the value
was removed, and false
if the value was not set
to begin with.
pub fn contains(&self, id: u32) -> bool
[src]
Returns true
if id
is in the set.
pub fn clear(&mut self)
[src]
Completely wipes out the bit set.
Trait Implementations
impl Join for BitSet
[src]
type Type = Index
Type of joined components.
type Value = ()
Type of joined storages.
type Mask = BitSet
Type of joined bit mask.
fn open(self) -> (Self::Mask, Self::Value)
[src]
Open this join by returning the mask and the storages.
unsafe fn get(_: &mut Self::Value, id: Index) -> Self::Type
[src]
Get a joined component value by a given index.
ⓘImportant traits for JoinIter<J>fn join(self) -> JoinIter<Self> where
Self: Sized,
[src]
Self: Sized,
Create a joined iterator over the contents.
impl ParJoin for BitSet
[src]
fn par_join(self) -> JoinParIter<Self> where
Self: Sized,
[src]
Self: Sized,
Create a joined parallel iterator over the contents.
impl<'a> Join for &'a BitSet
[src]
type Type = Index
Type of joined components.
type Value = ()
Type of joined storages.
type Mask = &'a BitSet
Type of joined bit mask.
fn open(self) -> (Self::Mask, Self::Value)
[src]
Open this join by returning the mask and the storages.
unsafe fn get(_: &mut Self::Value, id: Index) -> Self::Type
[src]
Get a joined component value by a given index.
ⓘImportant traits for JoinIter<J>fn join(self) -> JoinIter<Self> where
Self: Sized,
[src]
Self: Sized,
Create a joined iterator over the contents.
impl<'a> ParJoin for &'a BitSet
[src]
fn par_join(self) -> JoinParIter<Self> where
Self: Sized,
[src]
Self: Sized,
Create a joined parallel iterator over the contents.
impl<'a, B> BitAndAssign<&'a B> for BitSet where
B: BitSetLike,
[src]
B: BitSetLike,
fn bitand_assign(&mut self, lhs: &B)
[src]
Performs the &=
operation.
impl<'a> IntoIterator for &'a BitSet
[src]
type Item = <BitIter<&'a BitSet> as Iterator>::Item
The type of the elements being iterated over.
type IntoIter = BitIter<&'a BitSet>
Which kind of iterator are we turning this into?
fn into_iter(self) -> <&'a BitSet as IntoIterator>::IntoIter
[src]
Creates an iterator from a value. Read more
impl IntoIterator for BitSet
[src]
type Item = <BitIter<BitSet> as Iterator>::Item
The type of the elements being iterated over.
type IntoIter = BitIter<BitSet>
Which kind of iterator are we turning this into?
fn into_iter(self) -> <BitSet as IntoIterator>::IntoIter
[src]
Creates an iterator from a value. Read more
impl<'a, T> BitOr<T> for &'a BitSet where
T: BitSetLike,
[src]
T: BitSetLike,
type Output = BitSetOr<&'a BitSet, T>
The resulting type after applying the |
operator.
fn bitor(self, rhs: T) -> <&'a BitSet as BitOr<T>>::Output
[src]
Performs the |
operation.
impl<T> BitOr<T> for BitSet where
T: BitSetLike,
[src]
T: BitSetLike,
type Output = BitSetOr<BitSet, T>
The resulting type after applying the |
operator.
fn bitor(self, rhs: T) -> <BitSet as BitOr<T>>::Output
[src]
Performs the |
operation.
impl<'a, T> BitXor<T> for &'a BitSet where
T: BitSetLike,
[src]
T: BitSetLike,
type Output = BitSetXor<&'a BitSet, T>
The resulting type after applying the ^
operator.
fn bitxor(self, rhs: T) -> <&'a BitSet as BitXor<T>>::Output
[src]
Performs the ^
operation.
impl<T> BitXor<T> for BitSet where
T: BitSetLike,
[src]
T: BitSetLike,
type Output = BitSetXor<BitSet, T>
The resulting type after applying the ^
operator.
fn bitxor(self, rhs: T) -> <BitSet as BitXor<T>>::Output
[src]
Performs the ^
operation.
impl BitSetLike for BitSet
[src]
fn layer3(&self) -> usize
[src]
Return a usize
where each bit represents if any word in layer2 has been set. Read more
fn layer2(&self, i: usize) -> usize
[src]
Return the usize
from the array of usizes that indicates if any bit has been set in layer1 Read more
fn layer1(&self, i: usize) -> usize
[src]
Return the usize
from the array of usizes that indicates if any bit has been set in layer0 Read more
fn layer0(&self, i: usize) -> usize
[src]
Return a usize
that maps to the direct 1:1 association with each index of the set Read more
fn contains(&self, i: u32) -> bool
[src]
Allows checking if set bit is contained in the bit set.
fn get_from_layer(&self, layer: usize, idx: usize) -> usize
[src]
Gets the usize
corresponding to layer and index. Read more
ⓘImportant traits for BitIter<T>fn iter(self) -> BitIter<Self>
[src]
Create an iterator that will scan over the keyspace
fn par_iter(self) -> BitParIter<Self>
[src]
Create a parallel iterator that will scan over the keyspace
impl<'a> Extend<&'a u32> for BitSet
[src]
fn extend<T>(&mut self, iter: T) where
T: IntoIterator<Item = &'a u32>,
[src]
T: IntoIterator<Item = &'a u32>,
Extends a collection with the contents of an iterator. Read more
impl Extend<u32> for BitSet
[src]
fn extend<T>(&mut self, iter: T) where
T: IntoIterator<Item = u32>,
[src]
T: IntoIterator<Item = u32>,
Extends a collection with the contents of an iterator. Read more
impl Not for BitSet
[src]
type Output = BitSetNot<BitSet>
The resulting type after applying the !
operator.
fn not(self) -> <BitSet as Not>::Output
[src]
Performs the unary !
operation.
impl<'a> Not for &'a BitSet
[src]
type Output = BitSetNot<&'a BitSet>
The resulting type after applying the !
operator.
fn not(self) -> <&'a BitSet as Not>::Output
[src]
Performs the unary !
operation.
impl<'a, B> BitXorAssign<&'a B> for BitSet where
B: BitSetLike,
[src]
B: BitSetLike,
fn bitxor_assign(&mut self, lhs: &B)
[src]
Performs the ^=
operation.
impl<'a> FromIterator<&'a u32> for BitSet
[src]
fn from_iter<T>(iter: T) -> BitSet where
T: IntoIterator<Item = &'a u32>,
[src]
T: IntoIterator<Item = &'a u32>,
Creates a value from an iterator. Read more
impl FromIterator<u32> for BitSet
[src]
fn from_iter<T>(iter: T) -> BitSet where
T: IntoIterator<Item = u32>,
[src]
T: IntoIterator<Item = u32>,
Creates a value from an iterator. Read more
impl Clone for BitSet
[src]
fn clone(&self) -> BitSet
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<'a, T> BitAnd<T> for &'a BitSet where
T: BitSetLike,
[src]
T: BitSetLike,
type Output = BitSetAnd<&'a BitSet, T>
The resulting type after applying the &
operator.
fn bitand(self, rhs: T) -> <&'a BitSet as BitAnd<T>>::Output
[src]
Performs the &
operation.
impl<T> BitAnd<T> for BitSet where
T: BitSetLike,
[src]
T: BitSetLike,
type Output = BitSetAnd<BitSet, T>
The resulting type after applying the &
operator.
fn bitand(self, rhs: T) -> <BitSet as BitAnd<T>>::Output
[src]
Performs the &
operation.
impl<'a, B> BitOrAssign<&'a B> for BitSet where
B: BitSetLike,
[src]
B: BitSetLike,
fn bitor_assign(&mut self, lhs: &B)
[src]
Performs the |=
operation.
impl Debug for BitSet
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>
[src]
Formats the value using the given formatter. Read more