Struct box_stream::BoxReader

pub struct BoxReader<R: Read> { /* fields omitted */ }

Wraps a reader, decrypting all reads.

Methods

impl<R: Read> BoxReader<R>

fn new(inner: R, key: Key, nonce: Nonce) -> BoxReader<R>

Create a new reader, wrapping inner and using key and nonce for decryption.

fn get_ref(&self) -> &R

Gets a reference to the underlying reader.

fn get_mut(&mut self) -> &mut R

Gets a mutable reference to the underlying reader.

It is inadvisable to directly write to the underlying reader.

fn into_inner(self) -> R

Unwraps this BoxReader, returning the underlying reader.

Trait Implementations

impl<R: Read> Read for BoxReader<R>

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

Read bytes from the wrapped reader and decrypt them.

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::Other: This is used to signal that a final header has been read. In this case, the error value is FINAL_ERROR.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

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

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

🔬 This is a nightly-only experimental API. (io)

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl<AR: AsyncRead> AsyncRead for BoxReader<AR>

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 read_buf<B>(&mut self, buf: &mut B) -> Result<Async<usize>, Error> where
    B: BufMut, 

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

fn framed<T>(self, codec: T) -> Framed<Self, T> where
    Self: AsyncWrite,
    T: Decoder + Encoder, 

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
    Self: AsyncWrite, 

Helper method for splitting this read/write object into two halves.