Struct ffsend_api::reader::EncryptedFileReader

pub struct EncryptedFileReader { /* private fields */ }

A lazy file reader, that encrypts the file with the given cipher and appends the cryptographic tag to the end of it.

This reader is lazy because the file data loaded from the system and encrypted when it is read from the reader. This greatly reduces memory usage for large files.

This reader encrypts the file data with an appended cryptographic tag.

The reader uses a small internal buffer as data is encrypted in blocks, which may output more data than fits in the given buffer while reading. The excess data is then returned on the next read.

Implementations

impl EncryptedFileReader

pub fn new(
    file: File,
    cipher: Cipher,
    key: &[u8],
    iv: &[u8]
) -> Result<Self, Error>

Construct a new reader for the given file with the given cipher.

This method consumes twice the size of the file in memory while constructing, and constructs a reader that has a size similar to the file.

It is recommended to wrap this reader in some sort of buffer, such as: std::io::BufReader

Trait Implementations

impl ExactLengthReader for EncryptedFileReader

fn len(&self) -> Result<u64, Error>

Calculate the total length of the encrypted file with the appended tag. Useful in combination with some progress monitor, to determine how much of the file is read or for example; sent over the network.

fn is_empty(&self) -> Result<bool, Error>

Check whehter this extact length reader is emtpy.

impl Read for EncryptedFileReader

The reader trait implementation.

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

Read from the encrypted file, and then the encryption tag.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> 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, appending them to buf.

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

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>where
    Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adapter which will chain this stream with another.

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

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

impl Send for EncryptedFileReader