Struct io_tether::Tether

pub struct Tether<I, T, R> { /* private fields */ }

A wrapper type which contains the underlying I/O object, it’s initializer, and resolver.

This in the main type exposed by the library. It implements AsyncRead and AsyncWrite whenever the underlying I/O object implements them.

Calling things like read_buf will result in the I/O automatically reconnecting if an error is detected during the underlying I/O call.

Note

Currently, there is no way to obtain a reference into the underlying I/O object. And the only way to reclaim the inner I/O type is by calling Tether::into_inner. This is by design, since in the future there may be reason to add unsafe code which cannot be guaranteed if outside callers can obtain references. In the future I may add these as unsafe functions if those cases can be described.

Implementations

impl<I, T, R> Tether<I, T, R>

pub fn new(inner: T, initializer: I, resolver: R) -> Self

Construct a tether object from an existing I/O source

pub fn get_resolver(&self) -> &R

Returns a reference to the resolver

pub fn get_resolver_mut(&mut self) -> &mut R

Returns a mutable reference to the resolver

pub fn get_initializer(&self) -> &I

Returns a reference to the initializer

pub fn get_initializer_mut(&mut self) -> &mut I

Returns a mutable reference to the initializer

pub fn into_inner(self) -> T

Consume the Tether, and return the underlying I/O type

pub fn get_context(&self) -> &Context

Returns a reference to the context

pub fn get_context_mut(&mut self) -> &mut Context

Returns a mutable reference to the context

impl<I, T, R> Tether<I, T, R>

where T: TetherIo<I>,

pub async fn connect(initializer: I, resolver: R) -> Result<Self, T::Error>

Connect to the I/O source

Invokes TetherIo::connect to establish the connection, the same method which is called when Tether attempts to reconnect.

Trait Implementations

impl<I, T, R> AsyncRead for Tether<I, T, R>

where T: AsyncRead + TetherIo<I, Error = Error>, I: Unpin, R: TetherResolver<Error = Error>,

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

Attempts to read from the AsyncRead into buf.

impl<I, T, R> AsyncWrite for Tether<I, T, R>

where T: AsyncWrite + TetherIo<I, Error = Error>, I: Unpin, R: TetherResolver<Error = Error>,

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

Attempt to write bytes from buf into the object.

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

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

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

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

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

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

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.