Struct mio::io_source::IoSource

pub struct IoSource<T> {
    state: IoSourceState,
    inner: T,
    selector_id: SelectorId,
}

Adapter for a RawFd or RawSocket providing an event::Source implementation.

IoSource enables registering any FD or socket wrapper with Poll.

While only implementations for TCP, UDP, and UDS (Unix only) are provided, Mio supports registering any FD or socket that can be registered with the underlying OS selector. IoSource provides the necessary bridge.

Notes

To handle the registrations and events properly all I/O operations (such as read, write, etc.) must go through the do_io method to ensure the internal state is updated accordingly.

Fields

state: IoSourceState

inner: T

selector_id: SelectorId

Implementations

impl<T> IoSource<T>

pub fn new(io: T) -> IoSource<T>

Create a new IoSource.

pub fn do_io<F, R>(&self, f: F) -> Result<R>

where F: FnOnce(&T) -> Result<R>,

Execute an I/O operations ensuring that the socket receives more events if it hits a WouldBlock error.

Notes

This method is required to be called for all I/O operations to ensure the user will receive events once the socket is ready again after returning a WouldBlock error.

pub fn into_inner(self) -> T

Returns the I/O source, dropping the state.

Notes

To ensure no more events are to be received for this I/O source first deregister it.

Trait Implementations

impl<T> Debug for IoSource<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for IoSource<T>

Be careful when using this method. All I/O operations that may block must go through the do_io method.

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for IoSource<T>

Be careful when using this method. All I/O operations that may block must go through the do_io method.

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Source for IoSource<T>

where T: AsRawFd,

fn register( &mut self, registry: &Registry, token: Token, interests: Interest, ) -> Result<()>

Register self with the given Registry instance.

fn reregister( &mut self, registry: &Registry, token: Token, interests: Interest, ) -> Result<()>

Re-register self with the given Registry instance.

fn deregister(&mut self, registry: &Registry) -> Result<()>

Deregister self from the given Registry instance.