Struct bastion::io::Handle

pub struct Handle<T> { /* fields omitted */ }

Handle that manages IO submitted to proactor system.

This handle wraps io element, its’ completion channel, if file, file buffers and input output operations It is single handedly responsible for dispatching correct operations to IO driver. Speed of IO bound to speed of executor, handle neither interferes with executor nor tightly coupled.

Implementations

impl<T> Handle<T>

pub fn get_ref(&self) -> &T

pub fn get_mut(&mut self) -> &mut T

pub fn into_inner(self) -> T

impl<T> Handle<T> where
    T: AsRawFd, 

pub fn new(io: T) -> Result<Handle<T>, Error>

impl Handle<TcpListener>

pub fn bind<A>(addr: A) -> Result<Handle<TcpListener>, Error> where
    A: ToSocketAddrs, 

pub async fn accept(&'_ self) -> Result<(Handle<TcpStream>, SocketAddr), Error>

pub fn incoming(
    &self
) -> impl Stream<Item = Result<Handle<TcpStream>, Error>> + Send + Unpin

impl Handle<TcpStream>

pub async fn connect<A>(sock_addrs: A) -> Result<Handle<TcpStream>, Error> where
    A: ToSocketAddrs, 

pub async fn send(&'_ self, buf: &'_ [u8]) -> Result<usize, Error>

pub async fn recv(&'_ self, buf: &'_ mut [u8]) -> Result<usize, Error>

pub async fn peek(&'_ self, buf: &'_ mut [u8]) -> Result<usize, Error>

impl Handle<UdpSocket>

pub fn bind<A>(addr: A) -> Result<Handle<UdpSocket>, Error> where
    A: ToSocketAddrs, 

pub async fn connect<A>(sock_addrs: A) -> Result<Handle<UdpSocket>, Error> where
    A: ToSocketAddrs, 

pub async fn send(&'_ self, buf: &'_ [u8]) -> Result<usize, Error>

pub async fn recv(&'_ self, buf: &'_ mut [u8]) -> Result<usize, Error>

pub async fn peek(&'_ self, buf: &'_ mut [u8]) -> Result<usize, Error>

pub async fn send_to<A>(
    &'_ self,
    buf: &'_ [u8],
    addr: A
) -> Result<usize, Error> where
    A: ToSocketAddrs, 

pub async fn recv_from(
    &'_ self,
    buf: &'_ mut [u8]
) -> Result<(usize, SocketAddr), Error>

pub async fn peek_from(
    &'_ self,
    buf: &'_ mut [u8]
) -> Result<(usize, SocketAddr), Error>

impl Handle<UnixListener>

pub fn bind<P>(path: P) -> Result<Handle<UnixListener>, Error> where
    P: AsRef<Path>, 

pub async fn accept(&'_ self) -> Result<(Handle<UnixStream>, SocketAddr), Error>

pub fn incoming(
    &self
) -> impl Stream<Item = Result<Handle<UnixStream>, Error>> + Send + Unpin

impl Handle<UnixStream>

pub async fn connect<P>(path: P) -> Result<Handle<UnixStream>, Error> where
    P: AsRef<Path>, 

pub fn pair() -> Result<(Handle<UnixStream>, Handle<UnixStream>), Error>

pub async fn send(&'_ self, buf: &'_ [u8]) -> Result<usize, Error>

pub async fn recv(&'_ self, buf: &'_ mut [u8]) -> Result<usize, Error>

pub async fn peek(&'_ self, buf: &'_ mut [u8]) -> Result<usize, Error>

impl Handle<UnixDatagram>

pub fn bind<P>(path: P) -> Result<Handle<UnixDatagram>, Error> where
    P: AsRef<Path>, 

pub fn pair() -> Result<(Handle<UnixDatagram>, Handle<UnixDatagram>), Error>

pub async fn send(&'_ self, buf: &'_ [u8]) -> Result<usize, Error>

pub async fn recv(&'_ self, buf: &'_ mut [u8]) -> Result<usize, Error>

pub async fn peek(&'_ self, buf: &'_ mut [u8]) -> Result<usize, Error>

pub async fn send_to<P>(
    &'_ self,
    buf: &'_ [u8],
    path: P
) -> Result<usize, Error> where
    P: AsRef<Path>, 

pub async fn recv_from(
    &'_ self,
    buf: &'_ mut [u8]
) -> Result<(usize, SocketAddr), Error>

pub async fn peek_from(
    &'_ self,
    buf: &'_ mut [u8]
) -> Result<(usize, SocketAddr), Error>

Trait Implementations

impl<T> AsRawFd for Handle<T> where
    T: AsRawFd, 

pub fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.

impl<'_> AsyncRead for &'_ Handle<TcpStream>

pub fn poll_read(
    self: Pin<&mut &'_ Handle<TcpStream>>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<'_> AsyncRead for &'_ Handle<File>

pub fn poll_read(
    self: Pin<&mut &'_ Handle<File>>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncRead for Handle<TcpStream>

pub fn poll_read(
    self: Pin<&mut Handle<TcpStream>>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncRead for Handle<File>

pub fn poll_read(
    self: Pin<&mut Handle<File>>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<'_> AsyncRead for &'_ Handle<UnixStream>

pub fn poll_read(
    self: Pin<&mut &'_ Handle<UnixStream>>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncRead for Handle<UnixStream>

pub fn poll_read(
    self: Pin<&mut Handle<UnixStream>>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncSeek for Handle<File>

pub fn poll_seek(
    self: Pin<&mut Handle<File>>,
    cx: &mut Context<'_>,
    pos: SeekFrom
) -> Poll<Result<u64, Error>>

Attempt to seek to an offset, in bytes, in a stream.

impl<'_> AsyncWrite for &'_ Handle<UnixStream>

pub fn poll_write(
    self: Pin<&mut &'_ Handle<UnixStream>>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

pub fn poll_flush(
    self: Pin<&mut &'_ Handle<UnixStream>>,
    _cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

pub fn poll_close(
    self: Pin<&mut &'_ Handle<UnixStream>>,
    _cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<'_> AsyncWrite for &'_ Handle<TcpStream>

pub fn poll_write(
    self: Pin<&mut &'_ Handle<TcpStream>>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

pub fn poll_flush(
    self: Pin<&mut &'_ Handle<TcpStream>>,
    _cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

pub fn poll_close(
    self: Pin<&mut &'_ Handle<TcpStream>>,
    _cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl AsyncWrite for Handle<UnixStream>

pub fn poll_write(
    self: Pin<&mut Handle<UnixStream>>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

pub fn poll_flush(
    self: Pin<&mut Handle<UnixStream>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

pub fn poll_close(
    self: Pin<&mut Handle<UnixStream>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<'_> AsyncWrite for &'_ Handle<File>

pub fn poll_write(
    self: Pin<&mut &'_ Handle<File>>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

pub fn poll_flush(
    self: Pin<&mut &'_ Handle<File>>,
    _cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

pub fn poll_close(
    self: Pin<&mut &'_ Handle<File>>,
    _cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl AsyncWrite for Handle<TcpStream>

pub fn poll_write(
    self: Pin<&mut Handle<TcpStream>>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

pub fn poll_flush(
    self: Pin<&mut Handle<TcpStream>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

pub fn poll_close(
    self: Pin<&mut Handle<TcpStream>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl AsyncWrite for Handle<File>

pub fn poll_write(
    self: Pin<&mut Handle<File>>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

pub fn poll_flush(
    self: Pin<&mut Handle<File>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

pub fn poll_close(
    self: Pin<&mut Handle<File>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<T> Debug for Handle<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> Deref for Handle<T>

type Target = T

The resulting type after dereferencing.

pub fn deref(&self) -> &<Handle<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for Handle<T>

pub fn deref_mut(&mut self) -> &mut <Handle<T> as Deref>::Target

Mutably dereferences the value.

impl<T> HandleOpRegisterer for Handle<T>

pub fn read_registerer(
    &self
) -> Arc<TTas<Option<Pin<Box<dyn Future<Output = Result<usize, Error>> + 'static, Global>>>>>

pub fn write_registerer(
    &self
) -> Arc<TTas<Option<Pin<Box<dyn Future<Output = Result<usize, Error>> + 'static, Global>>>>>

impl<'_, T> HandleOpRegisterer for &'_ Handle<T>

pub fn read_registerer(
    &self
) -> Arc<TTas<Option<Pin<Box<dyn Future<Output = Result<usize, Error>> + 'static, Global>>>>>

pub fn write_registerer(
    &self
) -> Arc<TTas<Option<Pin<Box<dyn Future<Output = Result<usize, Error>> + 'static, Global>>>>>

impl<T> IntoRawFd for Handle<T> where
    T: IntoRawFd, 

pub fn into_raw_fd(self) -> i32

Consumes this object, returning the raw underlying file descriptor.

impl<T> Send for Handle<T>

impl<T> Sync for Handle<T>