Struct calloop::channel::Channel

pub struct Channel<T> { /* private fields */ }

The receiving end of the channel

This is the event source to be inserted into your EventLoop.

Implementations

impl<T> Channel<T>

pub fn recv(&self) -> Result<T, RecvError>

Proxy for mpsc::Receiver::recv to manually poll events.

Note: Normally you would want to use the Channel by inserting it into an event loop instead. Use this for example to immediately dispatch pending events after creation.

pub fn try_recv(&self) -> Result<T, TryRecvError>

Proxy for mpsc::Receiver::try_recv to manually poll events.

Note: Normally you would want to use the Channel by inserting it into an event loop instead. Use this for example to immediately dispatch pending events after creation.

Trait Implementations

impl<T: Debug> Debug for Channel<T>

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

Formats the value using the given formatter.

impl<T> EventSource for Channel<T>

type Event = Event<T>

The type of events generated by your source.

type Metadata = ()

Some metadata of your event source

type Ret = ()

The return type of the user callback

type Error = ChannelError

The error type returned from process_events() (not the user callback!).

fn process_events<C>( &mut self, readiness: Readiness, token: Token, callback: C, ) -> Result<PostAction, Self::Error>

where C: FnMut(Self::Event, &mut Self::Metadata) -> Self::Ret,

Process any relevant events

fn register( &mut self, poll: &mut Poll, token_factory: &mut TokenFactory, ) -> Result<()>

Register yourself to this poll instance

fn reregister( &mut self, poll: &mut Poll, token_factory: &mut TokenFactory, ) -> Result<()>

Re-register your file descriptors

fn unregister(&mut self, poll: &mut Poll) -> Result<()>

Unregister your file descriptors

const NEEDS_EXTRA_LIFECYCLE_EVENTS: bool = false

Whether this source needs to be sent the EventSource::before_sleep and EventSource::before_handle_events notifications. These are opt-in because they require more expensive checks, and almost all sources will not need these notifications

fn before_sleep(&mut self) -> Result<Option<(Readiness, Token)>>

Notification that a single poll is about to begin

fn before_handle_events(&mut self, events: EventIterator<'_>)

Notification that polling is complete, and EventSource::process_events will be called with the given events for this source. The iterator may be empty, which indicates that no events were generated for this source

impl<T: Send> Send for Channel<T>