Struct Event

pub struct Event { /* private fields */ }

An readiness event returned by Poll::poll.

Event is a readiness state paired with a Token. It is returned by Poll::poll.

For more documentation on polling and events, see Poll.

Examples

use soio::{Event, Ready, Token};

let event = Event::new(Ready::readable() | Ready::writable(), Token(0));

assert_eq!(event.readiness(), Ready::readable() | Ready::writable());
assert_eq!(event.token(), Token(0));

Implementations

impl Event

pub fn new(readiness: Ready, token: Token) -> Event

Creates a new Event containing readiness and token

Examples

use soio::{Event, Ready, Token};

let event = Event::new(Ready::readable() | Ready::writable(), Token(0));

assert_eq!(event.readiness(), Ready::readable() | Ready::writable());
assert_eq!(event.token(), Token(0));

pub fn readiness(&self) -> Ready

Returns the event’s readiness.

Examples

use soio::{Event, Ready, Token};

let event = Event::new(Ready::readable() | Ready::writable(), Token(0));

assert_eq!(event.readiness(), Ready::readable() | Ready::writable());

pub fn token(&self) -> Token

Returns the event’s token.

Examples

use soio::{Event, Ready, Token};

let event = Event::new(Ready::readable() | Ready::writable(), Token(0));

assert_eq!(event.token(), Token(0));

Trait Implementations

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 Debug for Event

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

Formats the value using the given formatter.

impl PartialEq for Event

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Event

impl Eq for Event

impl StructuralPartialEq for Event