Struct input::State

source ·
pub struct State<CustomEvent: CustomEvent> { /* private fields */ }
Expand description

Input thread state.

Implementations§

source§

impl<CustomEvent: CustomEvent> State<CustomEvent>

source

pub fn pause(&self)

Pause the event read thread.

source

pub fn resume(&self)

Resume the event read thread.

source

pub fn end(&self)

Permanently End the event read thread.

source

pub fn enqueue_event(&self, event: Event<CustomEvent>)

Add an event after existing events.

source

pub fn push_event(&self, event: Event<CustomEvent>)

Add an event before existing events.

source

pub fn read_event(&self) -> Event<CustomEvent>

Read an event from the queue. This function will block for a while until an event is available. And if no event is available, it will return Event::None.

Trait Implementations§

source§

impl<CustomEvent: Clone + CustomEvent> Clone for State<CustomEvent>

source§

fn clone(&self) -> State<CustomEvent>

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<CustomEvent: Debug + CustomEvent> Debug for State<CustomEvent>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<CustomEvent> !RefUnwindSafe for State<CustomEvent>

§

impl<CustomEvent> Send for State<CustomEvent>where CustomEvent: Send,

§

impl<CustomEvent> Sync for State<CustomEvent>where CustomEvent: Send,

§

impl<CustomEvent> Unpin for State<CustomEvent>

§

impl<CustomEvent> !UnwindSafe for State<CustomEvent>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.