Struct ModMask

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

Implementations

impl ModMask

pub const SHIFT: ModMask = _

pub const LOCK: ModMask = _

pub const CONTROL: ModMask = _

pub const M1: ModMask = _

pub const M2: ModMask = _

pub const M3: ModMask = _

pub const M4: ModMask = _

pub const M5: ModMask = _

pub const ANY: ModMask = _

impl ModMask

pub fn contains(self, flag: impl Into<u16>) -> bool

Check if this object has all bits set that are also set in flag.

flag can be a single enum variant or a whole other mask.

pub fn intersects(self, flag: impl Into<u16>) -> bool

Check if this object has some bits set that are also set in flag.

flag can be a single enum variant or a whole other mask.

pub fn remove(self, flags: impl Into<u16>) -> ModMask

Remove some flags.

All bits that are set in the given flags are removed from the self instance, if they are present.

pub fn bits(self) -> u16

Returns the internal value of the object.

Trait Implementations

impl BitAnd<u16> for ModMask

type Output = ModMask

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd for ModMask

type Output = ModMask

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<u16> for ModMask

fn bitand_assign(&mut self, other: u16)

Performs the &= operation.

impl BitAndAssign for ModMask

fn bitand_assign(&mut self, other: ModMask)

Performs the &= operation.

impl BitOr<u16> for ModMask

type Output = ModMask

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr for ModMask

type Output = ModMask

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<u16> for ModMask

fn bitor_assign(&mut self, other: u16)

Performs the |= operation.

impl BitOrAssign for ModMask

fn bitor_assign(&mut self, other: ModMask)

Performs the |= operation.

impl Clone for ModMask

fn clone(&self) -> ModMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModMask

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

Formats the value using the given formatter.

impl Default for ModMask

fn default() -> ModMask

Returns the “default value” for a type.

impl From<u16> for ModMask

fn from(value: u16) -> ModMask

Converts to this type from the input type.

impl From<u8> for ModMask

fn from(value: u8) -> ModMask

Converts to this type from the input type.

impl Hash for ModMask

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 Ord for ModMask

fn cmp(&self, other: &ModMask) -> 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 ModMask

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

fn partial_cmp(&self, other: &ModMask) -> 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 ModMask

impl Eq for ModMask

impl StructuralPartialEq for ModMask