Struct sdl2::keyboard::Mod

pub const fn empty() -> Mod

Returns an empty set of flags

pub const fn all() -> Mod

Returns the set containing all flags.

pub const 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 const fn from_bits_truncate(bits: u16) -> Mod

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

pub const unsafe fn from_bits_unchecked(bits: u16) -> Mod

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

pub const 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 Binary for Mod

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

Formats the value using the given formatter.

impl BitAnd for Mod

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

Returns the intersection between the two sets of flags.

type Output = Mod

The resulting type after applying the & operator.

impl BitAndAssign for Mod

fn bitand_assign(&mut self, other: Mod)

Disables all flags disabled in the set.

impl BitOr for Mod

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

Returns the union of the two sets of flags.

type Output = Mod

The resulting type after applying the | operator.

impl BitOrAssign for Mod

fn bitor_assign(&mut self, other: Mod)

Adds the set of flags.

impl BitXor for Mod

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

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

type Output = Mod

The resulting type after applying the ^ operator.

impl BitXorAssign for Mod

fn bitxor_assign(&mut self, other: Mod)

Toggles the set of flags.

impl Clone for Mod

fn clone(&self) -> Mod

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Mod

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

Formats the value using the given formatter. Read more

impl Display for Mod

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

Formats the value using the given formatter. Read more

impl Extend<Mod> for Mod

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

Extends a collection with the contents of an iterator. Read more

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements. Read more

impl FromIterator<Mod> for Mod

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

Creates a value from an iterator. Read more

impl Hash for Mod

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

Feeds this value into the given Hasher. Read more

1.3.0 · source§

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

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

impl LowerHex for Mod

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

Formats the value using the given formatter.

impl Not for Mod

fn not(self) -> Mod

Returns the complement of this set of flags.

type Output = Mod

The resulting type after applying the ! operator.

impl Octal for Mod

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

Formats the value using the given formatter.

impl Ord for Mod

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

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

1.21.0 · source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more

impl PartialEq for Mod

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

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

1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Mod

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

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

1.0.0 · source§

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

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

1.0.0 · source§

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

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

1.0.0 · source§

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

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

1.0.0 · source§

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

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

impl Sub for Mod

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

Returns the set difference of the two sets of flags.

type Output = Mod

The resulting type after applying the - operator.

impl SubAssign for Mod

fn sub_assign(&mut self, other: Mod)

Disables all flags enabled in the set.

impl UpperHex for Mod

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

Formats the value using the given formatter.

impl Copy for Mod

impl Eq for Mod

impl StructuralEq for Mod

impl StructuralPartialEq for Mod

Auto Trait Implementations§

impl RefUnwindSafe for Mod

impl Send for Mod

impl Sync for Mod

impl Unpin for Mod

impl UnwindSafe for Mod

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.