Struct StateSet 

pub struct StateSet(/* private fields */);

A superposition of multiple State’s.

You must use Self::scope to set the total number of states.

Implementations

impl StateSet

pub fn scope<R>(state_count: u32, scope: impl FnOnce() -> R) -> R

All StateSet’s created in scope will have state_count states.

pub fn with_states(states: &[State]) -> Self

Creates a superposition of states.

pub fn len() -> u32

The total number of states, as defined by Self::scope.

pub fn all() -> Self

Superposition of all states.

pub fn entropy(&self) -> u32

Total number of possible states, minus 1.

pub fn has(&self, state: State) -> bool

Is state within the superposition?

pub fn has_any(&self, states: &Self) -> bool

Are any of states within the superposition?

pub fn remove(&mut self, state: State)

Remove state from the superposition.

pub fn remove_all(&mut self, states: &Self)

Remove all states from the superposition.

pub fn add(&mut self, state: State)

Add state to the superposition.

pub fn add_all(&mut self, states: &Self)

Add all states to the superposition.

pub fn retain(&mut self, filter: impl FnMut(State) -> bool)

Filter states in place.

Trait Implementations

impl BitAnd for StateSet

type Output = StateSet

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr<State> for StateSet

type Output = StateSet

The resulting type after applying the | operator.

fn bitor(self, rhs: State) -> Self::Output

Performs the | operation.

impl BitOr for StateSet

type Output = StateSet

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitXor for StateSet

type Output = StateSet

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl Clone for StateSet

fn clone(&self) -> StateSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateSet

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

Formats the value using the given formatter.

impl Hash for StateSet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StateSet

fn eq(&self, other: &StateSet) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for StateSet

impl StructuralPartialEq for StateSet