Struct oxygengine_core::ecs::hibitset::AtomicBitSet

pub struct AtomicBitSet { /* fields omitted */ }

This is similar to a BitSet but allows setting of value without unique ownership of the structure

An AtomicBitSet has the ability to add an item to the set without unique ownership (given that the set is big enough). Removing elements does require unique ownership as an effect of the hierarchy it holds. Worst case multiple writers set the same bit twice (but only is told they set it).

It is possible to atomically remove from the set, but not at the same time as atomically adding. This is because there is no way to know if layer 1-3 would be left in a consistent state if they are being cleared and set at the same time.

AtromicBitSet resolves this race by disallowing atomic clearing of bits.

Implementations

impl AtomicBitSet

pub fn new() -> AtomicBitSet

Creates an empty AtomicBitSet.

pub fn add_atomic(&self, id: u32) -> bool

Adds id to the AtomicBitSet. Returns true if the value was already in the set.

Because we cannot safely extend an AtomicBitSet without unique ownership this will panic if the Index is out of range.

pub fn add(&mut self, id: u32) -> bool

Adds id to the BitSet. Returns true if the value was already in the set.

pub fn remove(&mut self, id: u32) -> bool

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

Returns true if id is in the set.

pub fn clear(&mut self)

Clear all bits in the set

Trait Implementations

impl<T> BitAnd<T> for AtomicBitSet where
    T: BitSetLike, 

type Output = BitSetAnd<AtomicBitSet, T>

The resulting type after applying the & operator.

pub fn bitand(self, rhs: T) -> <AtomicBitSet as BitAnd<T>>::Output

Performs the & operation.

impl<'a, T> BitAnd<T> for &'a AtomicBitSet where
    T: BitSetLike, 

type Output = BitSetAnd<&'a AtomicBitSet, T>

The resulting type after applying the & operator.

pub fn bitand(self, rhs: T) -> <&'a AtomicBitSet as BitAnd<T>>::Output

Performs the & operation.

impl<'a, T> BitOr<T> for &'a AtomicBitSet where
    T: BitSetLike, 

type Output = BitSetOr<&'a AtomicBitSet, T>

The resulting type after applying the | operator.

pub fn bitor(self, rhs: T) -> <&'a AtomicBitSet as BitOr<T>>::Output

Performs the | operation.

impl<T> BitOr<T> for AtomicBitSet where
    T: BitSetLike, 

type Output = BitSetOr<AtomicBitSet, T>

The resulting type after applying the | operator.

pub fn bitor(self, rhs: T) -> <AtomicBitSet as BitOr<T>>::Output

Performs the | operation.

impl BitSetLike for AtomicBitSet

pub fn layer3(&self) -> usize

Return a usize where each bit represents if any word in layer2 has been set.

pub fn layer2(&self, i: usize) -> usize

Return the usize from the array of usizes that indicates if any bit has been set in layer1

pub fn layer1(&self, i: usize) -> usize

Return the usize from the array of usizes that indicates if any bit has been set in layer0

pub fn layer0(&self, i: usize) -> usize

Return a usize that maps to the direct 1:1 association with each index of the set

pub fn contains(&self, i: u32) -> bool

Allows checking if set bit is contained in the bit set.

pub fn get_from_layer(&self, layer: usize, idx: usize) -> usize

Gets the usize corresponding to layer and index.

pub fn is_empty(&self) -> bool

Returns true if this BitSetLike contains nothing, and false otherwise.

pub fn iter(self) -> BitIter<Self>

Create an iterator that will scan over the keyspace

impl<T> BitXor<T> for AtomicBitSet where
    T: BitSetLike, 

type Output = BitSetXor<AtomicBitSet, T>

The resulting type after applying the ^ operator.

pub fn bitxor(self, rhs: T) -> <AtomicBitSet as BitXor<T>>::Output

Performs the ^ operation.

impl<'a, T> BitXor<T> for &'a AtomicBitSet where
    T: BitSetLike, 

type Output = BitSetXor<&'a AtomicBitSet, T>

The resulting type after applying the ^ operator.

pub fn bitxor(self, rhs: T) -> <&'a AtomicBitSet as BitXor<T>>::Output

Performs the ^ operation.

impl Debug for AtomicBitSet

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

Formats the value using the given formatter.

impl Default for AtomicBitSet

pub fn default() -> AtomicBitSet

Returns the “default value” for a type.

impl DrainableBitSet for AtomicBitSet

pub fn remove(&mut self, i: u32) -> bool

Removes bit from the bit set.

pub fn drain(&'a mut self) -> DrainBitIter<'a, Self>

Create a draining iterator that will scan over the keyspace and clears it while doing so.

impl<'a> Extend<&'a u32> for AtomicBitSet

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = &'a u32>, 

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<u32> for AtomicBitSet

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = u32>, 

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> FromIterator<&'a u32> for AtomicBitSet

pub fn from_iter<T>(iter: T) -> AtomicBitSet where
    T: IntoIterator<Item = &'a u32>, 

Creates a value from an iterator.

impl FromIterator<u32> for AtomicBitSet

pub fn from_iter<T>(iter: T) -> AtomicBitSet where
    T: IntoIterator<Item = u32>, 

Creates a value from an iterator.

impl IntoIterator for AtomicBitSet

type Item = <BitIter<AtomicBitSet> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = BitIter<AtomicBitSet>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <AtomicBitSet as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a AtomicBitSet

type Item = <BitIter<&'a AtomicBitSet> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = BitIter<&'a AtomicBitSet>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl<'a> Join for &'a AtomicBitSet

type Type = u32

Type of joined components.

type Value = ()

Type of joined storages.

type Mask = &'a AtomicBitSet

Type of joined bit mask.

pub unsafe fn open(
    self
) -> (<&'a AtomicBitSet as Join>::Mask, <&'a AtomicBitSet as Join>::Value)

Open this join by returning the mask and the storages.

pub unsafe fn get(
    &mut <&'a AtomicBitSet as Join>::Value,
    id: u32
) -> <&'a AtomicBitSet as Join>::Type

Get a joined component value by a given index.

pub fn join(self) -> JoinIter<Self>

Create a joined iterator over the contents.

pub fn maybe(self) -> MaybeJoin<Self>

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

pub 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.

impl Join for AtomicBitSet

type Type = u32

Type of joined components.

type Value = ()

Type of joined storages.

type Mask = AtomicBitSet

Type of joined bit mask.

pub unsafe fn open(
    self
) -> (<AtomicBitSet as Join>::Mask, <AtomicBitSet as Join>::Value)

Open this join by returning the mask and the storages.

pub unsafe fn get(
    &mut <AtomicBitSet as Join>::Value,
    id: u32
) -> <AtomicBitSet as Join>::Type

Get a joined component value by a given index.

pub fn join(self) -> JoinIter<Self>

Create a joined iterator over the contents.

pub fn maybe(self) -> MaybeJoin<Self>

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

pub 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.

impl Not for AtomicBitSet

type Output = BitSetNot<AtomicBitSet>

The resulting type after applying the ! operator.

pub fn not(self) -> <AtomicBitSet as Not>::Output

Performs the unary ! operation.

impl<'a> Not for &'a AtomicBitSet

type Output = BitSetNot<&'a AtomicBitSet>

The resulting type after applying the ! operator.

pub fn not(self) -> <&'a AtomicBitSet as Not>::Output

Performs the unary ! operation.