Struct MioAdapter

pub struct MioAdapter<MT>(/* private fields */);

Adapt raw mio type to mioco Evented requirements.

See source of src/tcp.rs for example of usage.

Implementations

impl MioAdapter<UnixListener>

pub fn bind<P: AsRef<Path> + ?Sized>(addr: &P) -> Result<Self>

Bind to a port

pub fn try_clone(&self) -> Result<Self>

Try cloning the socket descriptor.

impl MioAdapter<UnixSocket>

pub fn stream() -> Result<UnixSocket>

Returns a new, unbound, Unix domain socket

pub fn connect<P: AsRef<Path> + ?Sized>( self, addr: &P, ) -> Result<(UnixStream, bool)>

Connect the socket to the specified address

pub fn bind<P: AsRef<Path> + ?Sized>(&self, addr: &P) -> Result<()>

Bind the socket to the specified address

pub fn try_clone(&self) -> Result<Self>

Clone

impl MioAdapter<UnixStream>

pub fn connect<P: AsRef<Path> + ?Sized>(path: &P) -> Result<UnixStream>

Connect UnixStream to path

pub fn try_clone(&self) -> Result<Self>

Clone

pub fn try_read_recv_fd( &mut self, buf: &mut [u8], ) -> Result<Option<(usize, Option<RawFd>)>>

Try reading data into a buffer.

This will not block.

pub fn read_recv_fd(&mut self, buf: &mut [u8]) -> Result<(usize, Option<RawFd>)>

Block on read.

pub fn try_write_send_fd(&self, buf: &[u8], fd: RawFd) -> Result<Option<usize>>

Try writing a data from the buffer.

This will not block.

pub fn write_send_fd(&mut self, buf: &[u8], fd: RawFd) -> Result<usize>

Block on write

impl MioAdapter<TcpListener>

pub fn local_addr(&self) -> Result<SocketAddr>

Local address

pub fn take_socket_error(&self) -> Result<()>

TODO: document

pub fn try_clone(&self) -> Result<TcpListener>

Try cloning the listener descriptor.

impl MioAdapter<TcpListener>

pub fn bind(addr: &SocketAddr) -> Result<Self>

Bind to a port

pub fn from_listener(listener: TcpListener, addr: &SocketAddr) -> Result<Self>

Creates a new TcpListener from an instance of a std::net::TcpListener type.

impl MioAdapter<TcpStream>

pub fn connect(addr: &SocketAddr) -> Result<Self>

Create a new TCP stream an issue a non-blocking connect to the specified address.

pub fn connect_stream(stream: TcpStream, addr: &SocketAddr) -> Result<Self>

Creates a new TcpStream from the pending socket inside the given std::net::TcpBuilder, connecting it to the address specified.

pub fn local_addr(&self) -> Result<SocketAddr>

Local address of connection.

pub fn peer_addr(&self) -> Result<SocketAddr>

Peer address of connection.

pub fn shutdown(&self, how: Shutdown) -> Result<()>

Shutdown the connection.

pub fn set_nodelay(&self, nodelay: bool) -> Result<()>

Set no_delay.

pub fn set_keepalive(&self, seconds: Option<u32>) -> Result<()>

Set keepalive.

pub fn take_socket_error(&self) -> Result<()>

TODO: document

pub fn try_clone(&self) -> Result<TcpStream>

Try cloning the socket descriptor.

impl MioAdapter<UdpSocket>

pub fn v4() -> Result<Self>

Return a new unbound IPv4 UDP Socket.

pub fn v6() -> Result<Self>

Return a new unbound IPv6 UDP Socket.

pub fn bound(addr: &SocketAddr) -> Result<Self>

Return a new bound UDP Socket.

pub fn bind(&self, addr: &SocketAddr) -> Result<()>

Bind the unbound UDP Socket.

pub fn local_addr(&self) -> Result<SocketAddr>

Local address of the Socket.

pub fn try_clone(&self) -> Result<UdpSocket>

Try cloning the socket.

pub fn recv(&mut self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>

Block on recv.

pub fn try_recv( &mut self, buf: &mut [u8], ) -> Result<Option<(usize, SocketAddr)>>

Try reading data into a buffer.

This will not block.

pub fn send(&mut self, buf: &[u8], target: &SocketAddr) -> Result<usize>

Block on send.

pub fn try_send(&self, buf: &[u8], target: &SocketAddr) -> Result<Option<usize>>

Try writing a data from the buffer.

This will not block.

pub fn set_broadcast(&self, on: bool) -> Result<()>

Set broadcast flag.

pub fn set_multicast_loop(&self, on: bool) -> Result<()>

Set multicast loop flag.

pub fn join_multicast(&self, multi: &IpAddr) -> Result<()>

Join multicast.

pub fn leave_multicast(&self, multi: &IpAddr) -> Result<()>

Leave multicast.

pub fn set_multicast_time_to_live(&self, ttl: i32) -> Result<()>

Set multicast TTL.

impl<MT> MioAdapter<MT>

where MT: Evented + 'static,

pub fn new(mio_type: MT) -> Self

Create MioAdapter from raw mio type.

impl<MT> MioAdapter<MT>

where MT: Evented + TryRead + 'static,

pub fn try_read(&mut self, buf: &mut [u8]) -> Result<Option<usize>>

Try reading data into a buffer.

This will not block.

impl<MT> MioAdapter<MT>

where MT: Evented + 'static + TryWrite,

pub fn try_write(&self, buf: &[u8]) -> Result<Option<usize>>

Try writing a data from the buffer.

This will not block.

impl<MT, O> MioAdapter<MT>

where MT: Evented + 'static + TryAccept<Output = O>, O: Evented + 'static,

pub fn try_accept(&self) -> Result<Option<MioAdapter<O>>>

Attempt to accept a pending connection.

This will not block.

impl<MT, O> MioAdapter<MT>

where MT: Evented + 'static + TryAccept<Output = O>, O: Evented + 'static,

pub fn accept(&self) -> Result<MioAdapter<O>>

Block on accepting a connection.

Trait Implementations

impl<MT> AsRawFd for MioAdapter<MT>

where MT: Evented + 'static + AsRawFd,

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<MT> EventedImpl for MioAdapter<MT>

where MT: Evented + 'static,

type Raw = MT

Raw IO type wrapped by this EventImpl

fn shared(&self) -> &RcEventSource<Self::Raw>

Get the wrapped io

impl<MT> FromRawFd for MioAdapter<MT>

where MT: Evented + 'static + FromRawFd,

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl<MT> Read for MioAdapter<MT>

where MT: Evented + TryRead + 'static,

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Block on read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<MT> Write for MioAdapter<MT>

where MT: Evented + 'static + TryWrite,

fn write(&mut self, buf: &[u8]) -> Result<usize>

Block on write.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl<T> Send for MioAdapter<T>

where T: Evented + Send,