Struct WriteHalf

pub struct WriteHalf<T, U> { /* private fields */ }

Async Encryption Write Half.

This struct has an internal buffer to hold encrypted bytes that were not written to the inner writter. Under “normal” circunstances, the internal buffer will be seldom used.

Implementations

impl<T, A, S> WriteHalf<T, Encryptor<A, S>>

where T: AsyncWrite, S: StreamPrimitive<A>, A: AeadInPlace, A::NonceSize: Sub<<S as StreamPrimitive<A>>::NonceOverhead>, NonceSize<A, S>: ArrayLength<u8>,

pub fn new(inner: T, encryptor: Encryptor<A, S>) -> Self

pub fn with_capacity( inner: T, encryptor: Encryptor<A, S>, size: usize, chunk_size: usize, ) -> Self

Trait Implementations

impl<T, A, S> AsyncWrite for WriteHalf<T, Encryptor<A, S>>

where T: AsyncWrite + Unpin, S: StreamPrimitive<A>, A: AeadInPlace, A::NonceSize: Sub<<S as StreamPrimitive<A>>::NonceOverhead>, NonceSize<A, S>: ArrayLength<u8>,

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

Encrypt buf content, write into self.inner and returns the number of bytes encrypted.

Since tokio runtime will call this function repeatedly with the same contents when Poll::Pending is returned, this function may return Poll::Pending only when trying to flush the internal buffer, otherwise it will always return Poll::Ready(Ok(n)), even if the inner writer fails.

This behavior was adopted to guarantee parity with the reading counterpart, the contents of buf must be encrypted only once, if the internal writing operation fails, the already encrypted contents will be written into the internal buffer instead.

It is guaranteed that 0 <= n <= buf.len()

Internally, the contents of buf will be splitted into chunks of self.chunk_size size, default to 1024 bytes, to avoid allocating a huge Vec<u8> when encrypting larger messages.

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.

impl<'__pin, T, U> Unpin for WriteHalf<T, U>

where PinnedFieldsOf<__Origin<'__pin, T, U>>: Unpin,