Struct StateMask 

pub struct StateMask { /* private fields */ }

Implementations

impl StateMask

pub fn none() -> Self

Create a new mask with all flags unset.

pub fn all() -> Self

Create a new mask with all flags set.

pub fn set<T>(&mut self, other: T)

where T: Into<StateMask> + Deref<Target = u32>,

Set all other flags.

other can be either a single flag or another mask.

pub fn unset<T>(&mut self, other: T)

where T: Into<StateMask> + Deref<Target = u32>,

Unset all other flags.

other can be either a single flag or another mask.

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

where T: Into<StateMask> + Deref<Target = u32>,

Toggle all other flags.

other can be either a single flag or another mask.

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

where T: Into<StateMask> + Deref<Target = u32>,

Check if the mask contains all of other’s flags.

other can be either a single flag or another mask.

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

where T: Into<StateMask> + Deref<Target = u32>,

Check if the mask has common flags with other.

other can be either a single flag or another mask.

pub fn is_all(&self) -> bool

Check if all flags are set.

pub fn is_none(&self) -> bool

Check if all flags are unset.

Methods from Deref<Target = u32>

pub const MIN: u32 = 0u32

pub const MAX: u32 = 4_294_967_295u32

pub const BITS: u32 = 32u32

Trait Implementations

impl BitAnd<State> for StateMask

type Output = StateMask

The resulting type after applying the & operator.

fn bitand(self, other: State) -> Self::Output

Performs the & operation.

impl BitAnd<StateMask> for State

type Output = StateMask

The resulting type after applying the & operator.

fn bitand(self, other: StateMask) -> Self::Output

Performs the & operation.

impl BitAnd for StateMask

type Output = StateMask

The resulting type after applying the & operator.

fn bitand(self, other: StateMask) -> Self::Output

Performs the & operation.

impl BitAndAssign<State> for StateMask

fn bitand_assign(&mut self, other: State)

Performs the &= operation.

impl BitAndAssign for StateMask

fn bitand_assign(&mut self, other: StateMask)

Performs the &= operation.

impl BitOr<State> for StateMask

type Output = StateMask

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<StateMask> for State

type Output = StateMask

The resulting type after applying the | operator.

fn bitor(self, other: StateMask) -> Self::Output

Performs the | operation.

impl BitOr for StateMask

type Output = StateMask

The resulting type after applying the | operator.

fn bitor(self, other: StateMask) -> Self::Output

Performs the | operation.

impl BitOrAssign<State> for StateMask

fn bitor_assign(&mut self, other: State)

Performs the |= operation.

impl BitOrAssign for StateMask

fn bitor_assign(&mut self, other: StateMask)

Performs the |= operation.

impl BitXor<State> for StateMask

type Output = StateMask

The resulting type after applying the ^ operator.

fn bitxor(self, other: State) -> Self::Output

Performs the ^ operation.

impl BitXor<StateMask> for State

type Output = StateMask

The resulting type after applying the ^ operator.

fn bitxor(self, other: StateMask) -> Self::Output

Performs the ^ operation.

impl BitXor for StateMask

type Output = StateMask

The resulting type after applying the ^ operator.

fn bitxor(self, other: StateMask) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<State> for StateMask

fn bitxor_assign(&mut self, other: State)

Performs the ^= operation.

impl BitXorAssign for StateMask

fn bitxor_assign(&mut self, other: StateMask)

Performs the ^= operation.

impl Clone for StateMask

fn clone(&self) -> StateMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for StateMask

fn deref(&self) -> &u32

Deref to the internal type.

Useful for FFI.

type Target = u32

The resulting type after dereferencing.

impl From<State> for StateMask

fn from(flag: State) -> Self

Create a mask from a single flag.

When creating a mask from multiple flags or another mask just use the clone method or the copy semantics.

impl Not for StateMask

type Output = StateMask

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for StateMask

fn cmp(&self, other: &StateMask) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StateMask

fn eq(&self, other: &StateMask) -> 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 PartialOrd for StateMask

fn partial_cmp(&self, other: &StateMask) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for StateMask

impl Eq for StateMask

impl StructuralPartialEq for StateMask