Enum leafwing_input_manager::user_input::InputButton

source · [−]

#[non_exhaustive]
pub enum InputButton {
    Gamepad(GamepadButtonType),
    Keyboard(KeyCode),
    Mouse(MouseButton),
}

Expand description

The values of a button-like input type

See InputMode for the value-less equivalent. Commonly stored in the UserInput enum.

Unfortunately we cannot use a trait object here, as the types used by Input require traits that are not object-safe.

Please contact the maintainers if you need support for another type!

Variants (Non-exhaustive)

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

`Gamepad(GamepadButtonType)`

A button on a gamepad

`Keyboard(KeyCode)`

A button on a keyboard

`Mouse(MouseButton)`

A button on a mouse

Trait Implementations

source

impl Clone for InputButton

source

fn clone(&self) -> InputButton

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

source

impl Debug for InputButton

source

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

Formats the value using the given formatter. Read more

source

impl Display for InputButton

source

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

Formats the value using the given formatter. Read more

source

impl From<GamepadButtonType> for InputButton

source

fn from(input: GamepadButtonType) -> Self

Performs the conversion.

source

impl From<InputButton> for UserInput

source

fn from(input: InputButton) -> Self

Performs the conversion.

source

impl From<InputButton> for InputMode

source

fn from(button: InputButton) -> Self

Performs the conversion.

source

impl From<KeyCode> for InputButton

source

fn from(input: KeyCode) -> Self

Performs the conversion.

source

impl From<MouseButton> for InputButton

source

fn from(input: MouseButton) -> Self

Performs the conversion.

source

impl Hash for InputButton

source

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,

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

source

impl PartialEq<InputButton> for InputButton

source

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

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

source

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

This method tests for !=.

source

impl StructuralPartialEq for InputButton

Auto Trait Implementations

impl RefUnwindSafe for InputButton

impl Send for InputButton

impl Sync for InputButton

impl Unpin for InputButton

impl UnwindSafe for InputButton

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

pub default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> Downcast for T where
T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> Downcast<T> for T

pub fn downcast(&self) -> &T

impl<T> DowncastSync for T where
T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<T> DynEq for T where
T: Any + Eq,

pub fn as_any(&self) -> &(dyn Any + 'static)

pub fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

impl<T> DynHash for T where
T: DynEq + Hash,

pub fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

pub fn dyn_hash(&self, state: &mut dyn Hasher)

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

pub fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

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

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

source

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

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<T> Upcast<T> for T

pub fn upcast(&self) -> Option<&T>

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Enum leafwing_input_manager::user_input::InputButton

Variants (Non-exhaustive)

Gamepad(GamepadButtonType)

Keyboard(KeyCode)

Mouse(MouseButton)

Trait Implementations

impl Clone for InputButton

fn clone(&self) -> InputButton

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

impl Debug for InputButton

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

impl Display for InputButton

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

impl From<GamepadButtonType> for InputButton

fn from(input: GamepadButtonType) -> Self

impl From<InputButton> for UserInput

fn from(input: InputButton) -> Self

impl From<InputButton> for InputMode

fn from(button: InputButton) -> Self

impl From<KeyCode> for InputButton

fn from(input: KeyCode) -> Self

impl From<MouseButton> for InputButton

fn from(input: MouseButton) -> Self

impl Hash for InputButton

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

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

impl PartialEq<InputButton> for InputButton

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

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

impl Copy for InputButton

impl Eq for InputButton

impl StructuralEq for InputButton

impl StructuralPartialEq for InputButton

Auto Trait Implementations

impl RefUnwindSafe for InputButton

impl Send for InputButton

impl Sync for InputButton

impl Unpin for InputButton

impl UnwindSafe for InputButton

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> CallHasher for T where T: Hash + ?Sized,

pub default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where H: Hash + ?Sized, B: BuildHasher,

impl<T> Downcast for T where T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

pub fn as_any(&self) -> &(dyn Any + 'static)

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> Downcast<T> for T

pub fn downcast(&self) -> &T

impl<T> DowncastSync for T where T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

impl<T> DynEq for T where T: Any + Eq,

pub fn as_any(&self) -> &(dyn Any + 'static)

pub fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

impl<T> DynHash for T where T: DynEq + Hash,

pub fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

pub fn dyn_hash(&self, state: &mut dyn Hasher)

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

pub fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

pub default fn to_string(&self) -> String

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

type Error = Infallible

`Gamepad(GamepadButtonType)`

`Keyboard(KeyCode)`

`Mouse(MouseButton)`

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

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

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

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

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

impl<T> CallHasher for T where
T: Hash + ?Sized,

pub default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<T> DynEq for T where
T: Any + Eq,

impl<T> DynHash for T where
T: DynEq + Hash,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

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

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

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

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

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

impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> Resource for T where
T: 'static + Send + Sync,

impl<T> StateData for T where
T: 'static + Send + Sync + Clone + Eq + Debug + Hash,