Struct StateSet

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

The bitflag representation of all states an object may have.

Implementations

impl StateSet

pub fn new<B>(value: B) -> StateSet

where B: Into<BitFlags<State>>,

Create a new StateSet.

Example

     let states = State::Focusable | State::Sensitive | State::Active;
     let set = StateSet::new(states);

     assert!(set.contains(State::Active));
     assert!(!set.contains(State::Busy));

pub fn from_bits(bits: u64) -> Result<StateSet, FromBitsError<State>>

Returns the StateSet that corresponds to the provided u64s bit pattern.

Errors

When the argument encodes an undefined State.

pub fn empty() -> StateSet

Create an empty StateSet

pub fn bits(&self) -> u64

Returns the state as represented by a u64.

pub fn contains<B>(self, other: B) -> bool

where B: Into<BitFlags<State>>,

Whether the StateSet contains a State.

pub fn remove<B>(&mut self, other: B)

where B: Into<BitFlags<State>>,

Removes a State (optionally) previously contained in the StateSet.

pub fn insert<B>(&mut self, other: B)

where B: Into<BitFlags<State>>,

Inserts a State in the StateSet.

pub fn iter(self) -> impl Iterator<Item = State>

Returns an iterator that yields each set State.

pub fn is_empty(self) -> bool

Checks if all states are unset.

pub fn intersects<B>(self, other: B) -> bool

where B: Into<BitFlags<State>>,

Returns true if at least one flag is shared.

pub fn toggle<B>(&mut self, other: B)

where B: Into<BitFlags<State>>,

Toggles the matching bits.

Trait Implementations

impl BitAnd for StateSet

type Output = StateSet

The resulting type after applying the & operator.

fn bitand(self, other: StateSet) -> <StateSet as BitAnd>::Output

Performs the & operation.

impl BitAndAssign for StateSet

fn bitand_assign(&mut self, other: StateSet)

Performs the &= operation.

impl BitOr for StateSet

type Output = StateSet

The resulting type after applying the | operator.

fn bitor(self, other: StateSet) -> <StateSet as BitOr>::Output

Performs the | operation.

impl BitOrAssign for StateSet

fn bitor_assign(&mut self, other: StateSet)

Performs the |= operation.

impl BitXor for StateSet

type Output = StateSet

The resulting type after applying the ^ operator.

fn bitxor(self, other: StateSet) -> <StateSet as BitXor>::Output

Performs the ^ operation.

impl BitXorAssign for StateSet

fn bitxor_assign(&mut self, other: StateSet)

Performs the ^= operation.

impl Clone for StateSet

fn clone(&self) -> StateSet

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Default for StateSet

fn default() -> StateSet

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StateSet

fn deserialize<D>( deserializer: D, ) -> Result<StateSet, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<State> for StateSet

fn from(value: State) -> StateSet

Converts to this type from the input type.

impl Hash for StateSet

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

where __H: Hasher,

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 Serialize for StateSet

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Type for StateSet

fn signature() -> Signature<'static>

Get the signature for the implementing type.

impl Copy for StateSet

impl Eq for StateSet

impl StructuralPartialEq for StateSet