Struct gaea::event::Event

pub struct Event { /* fields omitted */ }

A readiness event.

Event is a readiness state paired with an id. Events are returned by poll.

For more documentation on polling and events, see poll.

Examples

use gaea::{event, Event, Ready};

let my_event = Event::new(event::Id(0), Ready::READABLE | Ready::WRITABLE);

assert_eq!(my_event.id(), event::Id(0));
assert_eq!(my_event.readiness(), Ready::READABLE | Ready::WRITABLE);

Methods

impl Event

pub const fn new(id: Id, readiness: Ready) -> Event

Creates a new Event containing id and readiness.

pub const fn id(&self) -> Id

Returns the event's id.

pub const fn readiness(&self) -> Ready

Returns the event's readiness.

Trait Implementations

impl Eq for Event

impl PartialEq<Event> for Event

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

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

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

This method tests for !=.

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Event

impl Debug for Event

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

Formats the value using the given formatter.

impl Hash for Event

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

Feeds this value into the given [Hasher].

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

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