Struct sdl2::keyboard::Mod [−] 

pub struct Mod {
    // some fields omitted
}

Methods

impl Mod

fn empty() -> Mod

Returns an empty set of flags.

fn all() -> Mod

Returns the set containing all flags.

fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

fn from_bits(bits: u32) -> Option<Mod>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

fn from_bits_truncate(bits: u32) -> Mod

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

fn intersects(&self, other: Mod) -> bool

Returns true if there are flags common to both self and other.

fn contains(&self, other: Mod) -> bool

Returns true all of the flags in other are contained within self.

fn insert(&mut self, other: Mod)

Inserts the specified flags in-place.

fn remove(&mut self, other: Mod)

Removes the specified flags in-place.

fn toggle(&mut self, other: Mod)

Toggles the specified flags in-place.

Trait Implementations

impl Hash for Mod

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

Feeds this value into the state given, updating the hasher as necessary.

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

Feeds a slice of this type into the state provided.

impl Ord for Mod

fn cmp(&self, __arg_0: &Mod) -> Ordering

This method returns an Ordering between self and other. Read more

impl PartialOrd for Mod

fn partial_cmp(&self, __arg_0: &Mod) -> Option<Ordering>

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

fn lt(&self, __arg_0: &Mod) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

fn le(&self, __arg_0: &Mod) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

fn gt(&self, __arg_0: &Mod) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

fn ge(&self, __arg_0: &Mod) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl Clone for Mod

fn clone(&self) -> Mod

Returns a copy of the value. Read more

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

Performs copy-assignment from source. Read more

impl Eq for Mod

impl PartialEq for Mod

fn eq(&self, __arg_0: &Mod) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

fn ne(&self, __arg_0: &Mod) -> bool

This method tests for !=.

impl Copy for Mod

impl Debug for Mod

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

Formats the value using the given formatter.

impl BitOr for Mod

type Output = Mod

The resulting type after applying the | operator

fn bitor(self, other: Mod) -> Mod

Returns the union of the two sets of flags.

impl BitXor for Mod

type Output = Mod

The resulting type after applying the ^ operator

fn bitxor(self, other: Mod) -> Mod

Returns the left flags, but with all the right flags toggled.

impl BitAnd for Mod

type Output = Mod

The resulting type after applying the & operator

fn bitand(self, other: Mod) -> Mod

Returns the intersection between the two sets of flags.

impl Sub for Mod

type Output = Mod

The resulting type after applying the - operator

fn sub(self, other: Mod) -> Mod

Returns the set difference of the two sets of flags.

impl Not for Mod

type Output = Mod

The resulting type after applying the ! operator

fn not(self) -> Mod

Returns the complement of this set of flags.