Struct nuclei::Handle

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

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 Handle<File>

pub async fn open(p: impl AsRef<Path>) -> Result<Handle<File>>

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: AsRawFd> Handle<T>

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

impl Handle<TcpListener>

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

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

Single-call accept

pub async fn accept_multi(&self) -> Result<TcpStreamGenerator>

Multishot accept

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

impl Handle<TcpStream>

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

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

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

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

impl Handle<UdpSocket>

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

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

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

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

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

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

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

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

impl Handle<UnixListener>

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

pub async fn accept(&self) -> Result<(Handle<UnixStream>, UnixSocketAddr)>

pub fn incoming( &self ) -> impl Stream<Item = Result<Handle<UnixStream>>> + Unpin + '_

impl Handle<UnixStream>

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

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

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

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

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

impl Handle<UnixDatagram>

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

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

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

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

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

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

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

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

Trait Implementations

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

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncBufRead for Handle<File>

fn poll_fill_buf( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<&[u8]>>

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl AsyncRead for &Handle<TcpStream>

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

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>

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

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>

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

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>>

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

impl AsyncRead for Handle<TcpStream>

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

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>

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

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>

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

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

impl AsyncWrite for &Handle<TcpStream>

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

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>

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

fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>

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>

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

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>

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

fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>

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>

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, bufslice: &[u8] ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

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

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

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

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

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

impl AsyncWrite for Handle<TcpStream>

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

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

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

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

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>

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

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

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

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

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> Debug for Handle<T>

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

Formats the value using the given formatter.

impl<T> Deref for Handle<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Handle<T>

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

Mutably dereferences the value.

impl<T> HandleOpRegisterer for &Handle<T>

fn read_registerer(&self) -> Arc<TTas<Option<AsyncOp<usize>>>>

fn write_registerer(&self) -> Arc<TTas<Option<AsyncOp<usize>>>>

impl<T> HandleOpRegisterer for Handle<T>

fn read_registerer(&self) -> Arc<TTas<Option<AsyncOp<usize>>>>

fn write_registerer(&self) -> Arc<TTas<Option<AsyncOp<usize>>>>

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

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl<T> Send for Handle<T>

impl<T> Sync for Handle<T>