Struct stubborn_io::tokio::StubbornIo

pub struct StubbornIo<T, C> { /* fields omitted */ }

The StubbornIo is a wrapper over a tokio AsyncRead/AsyncWrite item that will automatically invoke the UnderlyingIo::establish upon initialization and when a reconnect is needed. Because it implements deref, you are able to invoke all of the original methods on the wrapped IO.

Methods

impl<T, C> StubbornIo<T, C> where
    T: UnderlyingIo<C>,
    C: Clone + Send + Unpin + 'static, 

pub async fn connect(ctor_arg: impl Borrow<C>) -> Result<Self>

Connects or creates a handle to the UnderlyingIo item, using the default reconnect options.

pub async fn connect_with_options(
    ctor_arg: impl Borrow<C>,
    options: ReconnectOptions
) -> Result<Self>

Trait Implementations

impl<T, C> DerefMut for StubbornIo<T, C>

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

Mutably dereferences the value.

impl<T, C> Deref for StubbornIo<T, C>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, C> AsyncWrite for StubbornIo<T, C> where
    T: UnderlyingIo<C> + AsyncWrite,
    C: Clone + Send + Unpin + 'static, 

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_shutdown(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_buf<B: Buf>(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut B
) -> Poll<Result<usize>>

Write a Buf into this value, returning how many bytes were written.

impl<T, C> AsyncRead for StubbornIo<T, C> where
    T: UnderlyingIo<C> + AsyncRead,
    C: Clone + Send + Unpin + 'static, 

unsafe fn prepare_uninitialized_buffer(&self, buf: &mut [u8]) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

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_buf<B: BufMut>(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut B
) -> Poll<Result<usize>>

Pull some bytes from this source into the specified BufMut, returning how many bytes were read.