[−]Struct sdl2::keyboard::Mod

pub struct Mod { /* fields omitted */ }

Methods

`impl Mod`

`pub const NOMOD: Mod`

`pub const LSHIFTMOD: Mod`

`pub const RSHIFTMOD: Mod`

`pub const LCTRLMOD: Mod`

`pub const RCTRLMOD: Mod`

`pub const LALTMOD: Mod`

`pub const RALTMOD: Mod`

`pub const LGUIMOD: Mod`

`pub const RGUIMOD: Mod`

`pub const NUMMOD: Mod`

`pub const CAPSMOD: Mod`

`pub const MODEMOD: Mod`

`pub const RESERVEDMOD: Mod`

`pub fn empty() -> Mod`

Returns an empty set of flags.

`pub fn all() -> Mod`

Returns the set containing all flags.

`pub fn bits(&self) -> u16`

Returns the raw value of the flags currently stored.

`pub fn from_bits(bits: u16) -> Option<Mod>`

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

`pub fn from_bits_truncate(bits: u16) -> Mod`

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

`pub fn is_empty(&self) -> bool`

Returns true if no flags are currently stored.

`pub fn is_all(&self) -> bool`

Returns true if all flags are currently set.

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

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

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

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

`pub fn insert(&mut self, other: Mod)`

Inserts the specified flags in-place.

`pub fn remove(&mut self, other: Mod)`

Removes the specified flags in-place.

`pub fn toggle(&mut self, other: Mod)`

Toggles the specified flags in-place.

`pub fn set(&mut self, other: Mod, value: bool)`

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

`impl Clone for Mod`

`fn clone(&self) -> Mod`

`default fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from source. Read more

`impl Ord for Mod`

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

`default fn max(self, other: Self) -> Self`
1.21.0
[src]

Compares and returns the maximum of two values. Read more

`default fn min(self, other: Self) -> Self`
1.21.0
[src]

Compares and returns the minimum of two values. Read more

`default fn clamp(self, min: Self, max: Self) -> Self`[src]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval. Read more

`impl Eq for Mod`

`impl Extend<Mod> for Mod`

`fn extend<T: IntoIterator<Item = Mod>>(&mut self, iterator: T)`

`impl PartialOrd<Mod> for Mod`

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

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

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

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

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

`impl Copy for Mod`

`impl PartialEq<Mod> for Mod`

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

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

`impl Binary for Mod`

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

`impl UpperHex for Mod`

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

`impl LowerHex for Mod`

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

`impl Debug for Mod`

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

`impl Octal for Mod`

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

`impl Hash for Mod`

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

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

Feeds a slice of this type into the given [Hasher]. Read more

`impl Sub<Mod> 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 SubAssign<Mod> for Mod`

`fn sub_assign(&mut self, other: Mod)`

Disables all flags enabled in the set.

`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.

`impl BitAnd<Mod> 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 BitOr<Mod> 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<Mod> 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 BitAndAssign<Mod> for Mod`

`fn bitand_assign(&mut self, other: Mod)`

Disables all flags disabled in the set.

`impl BitOrAssign<Mod> for Mod`

`fn bitor_assign(&mut self, other: Mod)`

Adds the set of flags.

`impl BitXorAssign<Mod> for Mod`

`fn bitxor_assign(&mut self, other: Mod)`

Toggles the set of flags.

`impl FromIterator<Mod> for Mod`

`fn from_iter<T: IntoIterator<Item = Mod>>(iterator: T) -> Mod`

Auto Trait Implementations

`impl Send for Mod`

`impl Sync for Mod`

Blanket Implementations

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> From for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T> Borrow for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

[−]Struct sdl2::keyboard::Mod

Methods

impl Mod

pub const NOMOD: Mod

pub const LSHIFTMOD: Mod

pub const RSHIFTMOD: Mod

pub const LCTRLMOD: Mod

pub const RCTRLMOD: Mod

pub const LALTMOD: Mod

pub const RALTMOD: Mod

pub const LGUIMOD: Mod

pub const RGUIMOD: Mod

pub const NUMMOD: Mod

pub const CAPSMOD: Mod

pub const MODEMOD: Mod

pub const RESERVEDMOD: Mod

pub fn empty() -> Mod

pub fn all() -> Mod

pub fn bits(&self) -> u16

pub fn from_bits(bits: u16) -> Option<Mod>

pub fn from_bits_truncate(bits: u16) -> Mod

pub fn is_empty(&self) -> bool

pub fn is_all(&self) -> bool

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

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

pub fn insert(&mut self, other: Mod)

pub fn remove(&mut self, other: Mod)

pub fn toggle(&mut self, other: Mod)

pub fn set(&mut self, other: Mod, value: bool)

Trait Implementations

impl Clone for Mod

fn clone(&self) -> Mod

default fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Ord for Mod

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

default fn max(self, other: Self) -> Self1.21.0[src]

default fn min(self, other: Self) -> Self1.21.0[src]

default fn clamp(self, min: Self, max: Self) -> Self[src]

impl Eq for Mod

impl Extend<Mod> for Mod

fn extend<T: IntoIterator<Item = Mod>>(&mut self, iterator: T)

impl PartialOrd<Mod> for Mod

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

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

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

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

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

impl Copy for Mod

impl PartialEq<Mod> for Mod

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

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

impl Binary for Mod

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

impl UpperHex for Mod

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

impl LowerHex for Mod

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

impl Debug for Mod

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

impl Octal for Mod

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

impl Hash for Mod

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

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

impl Sub<Mod> for Mod

type Output = Mod

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

impl SubAssign<Mod> for Mod

fn sub_assign(&mut self, other: Mod)

impl Not for Mod

type Output = Mod

fn not(self) -> Mod

impl BitAnd<Mod> for Mod

type Output = Mod

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

impl BitOr<Mod> for Mod

type Output = Mod

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

impl BitXor<Mod> for Mod

type Output = Mod

`impl Mod`

`pub const NOMOD: Mod`

`pub const LSHIFTMOD: Mod`

`pub const RSHIFTMOD: Mod`

`pub const LCTRLMOD: Mod`

`pub const RCTRLMOD: Mod`

`pub const LALTMOD: Mod`

`pub const RALTMOD: Mod`

`pub const LGUIMOD: Mod`

`pub const RGUIMOD: Mod`

`pub const NUMMOD: Mod`

`pub const CAPSMOD: Mod`

`pub const MODEMOD: Mod`

`pub const RESERVEDMOD: Mod`

`pub fn empty() -> Mod`

`pub fn all() -> Mod`

`pub fn bits(&self) -> u16`

`pub fn from_bits(bits: u16) -> Option<Mod>`

`pub fn from_bits_truncate(bits: u16) -> Mod`

`pub fn is_empty(&self) -> bool`

`pub fn is_all(&self) -> bool`

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

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

`pub fn insert(&mut self, other: Mod)`

`pub fn remove(&mut self, other: Mod)`

`pub fn toggle(&mut self, other: Mod)`

`pub fn set(&mut self, other: Mod, value: bool)`

`impl Clone for Mod`

`fn clone(&self) -> Mod`

`default fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

`impl Ord for Mod`

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

`default fn max(self, other: Self) -> Self`
1.21.0
[src]

`default fn min(self, other: Self) -> Self`
1.21.0
[src]

`default fn clamp(self, min: Self, max: Self) -> Self`[src]

`impl Eq for Mod`

`impl Extend<Mod> for Mod`

`fn extend<T: IntoIterator<Item = Mod>>(&mut self, iterator: T)`

`impl PartialOrd<Mod> for Mod`

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

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

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

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

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

`impl Copy for Mod`

`impl PartialEq<Mod> for Mod`

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

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

`impl Binary for Mod`

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

`impl UpperHex for Mod`

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

`impl LowerHex for Mod`

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

`impl Debug for Mod`

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

`impl Octal for Mod`

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

`impl Hash for Mod`

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

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

`impl Sub<Mod> for Mod`

`type Output = Mod`

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

`impl SubAssign<Mod> for Mod`

`fn sub_assign(&mut self, other: Mod)`

`impl Not for Mod`

`type Output = Mod`

`fn not(self) -> Mod`

`impl BitAnd<Mod> for Mod`

`type Output = Mod`

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

`impl BitOr<Mod> for Mod`

`type Output = Mod`

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

`impl BitXor<Mod> for Mod`

`type Output = Mod`

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

`impl BitAndAssign<Mod> for Mod`

`fn bitand_assign(&mut self, other: Mod)`