Struct sdl2::event::EventSender

source ·
pub struct EventSender { /* private fields */ }
Expand description

A sendible type that can push events to the event queue.

Implementations§

source§

impl EventSender

source

pub fn push_event(&self, event: Event) -> Result<(), String>

Pushes an event to the event queue.

source

pub fn push_custom_event<T: Any>(&self, event: T) -> Result<(), String>

Push a custom event

If the event type T was not registered using [EventSubsystem::register_custom_event] (../struct.EventSubsystem.html#method.register_custom_event), this method will panic.

Example: pushing and receiving a custom event
struct SomeCustomEvent {
    a: i32
}

let sdl = sdl2::init().unwrap();
let ev = sdl.event().unwrap();
let mut ep = sdl.event_pump().unwrap();

ev.register_custom_event::<SomeCustomEvent>().unwrap();

let event = SomeCustomEvent { a: 42 };

ev.push_custom_event(event);

let received = ep.poll_event().unwrap(); // or within a for event in ep.poll_iter()
if received.is_user_event() {
    let e2 = received.as_user_event_type::<SomeCustomEvent>().unwrap();
    assert_eq!(e2.a, 42);
}

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where 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 T
where 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, U> TryFrom<U> for T
where 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 T
where 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.