Struct box_stream::BoxDuplex

pub struct BoxDuplex<S> { /* fields omitted */ }

Wraps a duplex stream, encrypting all writes and decrypting all reads.

Methods

impl<S> BoxDuplex<S>

pub fn new(
    inner: S,
    encryption_key: Key,
    decryption_key: Key,
    encryption_nonce: Nonce,
    decryption_nonce: Nonce
) -> BoxDuplex<S>

Create a new duplex stream, wrapping inner and the supplied keys and nonces for encryption and decryption.

pub fn get_ref(&self) -> &S

Gets a reference to the underlying stream.

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

Gets a mutable reference to the underlying stream.

It is inadvisable to directly write to or read from the underlying stream.

pub fn into_inner(self) -> S

Unwraps this BoxDuplex, returning the underlying stream.

Trait Implementations

impl<R: AsyncRead> AsyncRead for BoxDuplex<R>

fn poll_read(&mut self, cx: &mut Context, buf: &mut [u8]) -> Poll<usize, Error>

Read bytes from the wrapped reader and decrypt them. End of stream is signalled by returning Ok(0) even though this function was passed a buffer of nonzero length.

Errors

In addition to propagating all errors from the wrapped reader, a BoxReader produces the following error kinds:

• ErrorKind::InvalidData: If data could not be decrypted, or if a header declares an invalid length. Possible error values are INVALID_LENGTH, UNAUTHENTICATED_HEADER, UNAUTHENTICATED_PACKET. ErrorKind::UnexpectedEof: If a call to the inner reader returned Ok(0) although it was given a buffer of nonzero length. This is an error since end of file must be signalled via a special header in a box stream. The error value for this is UNAUTHENTICATED_EOF.

unsafe fn initializer(&self) -> Initializer

Determines if this AsyncReader can work with buffers of uninitialized memory.

fn poll_vectored_read(
    &mut self,
    cx: &mut Context,
    vec: &mut [&mut IoVec]
) -> Result<Async<usize>, Error>

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

impl<W: AsyncWrite> AsyncWrite for BoxDuplex<W>

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

Attempt to write bytes from buf into the object.

fn poll_flush(&mut self, cx: &mut Context) -> Poll<(), Error>

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

fn poll_close(&mut self, cx: &mut Context) -> Poll<(), Error>

Attempt to close the object.

fn poll_vectored_write(
    &mut self,
    cx: &mut Context,
    vec: &[&IoVec]
) -> Result<Async<usize>, Error>

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