Struct matrix_sdk_crypto::AttachmentEncryptor

pub struct AttachmentEncryptor<'a, R: Read + ?Sized> { /* private fields */ }

A wrapper that transparently encrypts anything that implements Read.

Implementations

impl<'a, R: Read + ?Sized + 'a> AttachmentEncryptor<'a, R>

pub fn new(reader: &'a mut R) -> Self

Wrap the given reader encrypting all the data we read from it.

After all the reads are done, and all the data is encrypted that we wish to encrypt a call to finish() is necessary to get the decryption key for the data.

Arguments

• reader - The Reader that should be wrapped and encrypted.

Panics

Panics if we can’t generate enough random data to create a fresh encryption key.

Examples

let data = "Hello world".to_owned();
let mut cursor = Cursor::new(data.clone());

let mut encryptor = AttachmentEncryptor::new(&mut cursor);

let mut encrypted = Vec::new();
encryptor.read_to_end(&mut encrypted).unwrap();
let key = encryptor.finish();

pub fn finish(self) -> MediaEncryptionInfo

Consume the encryptor and get the encryption key.

Trait Implementations

impl<'a, R: 'a + Read + Debug + ?Sized> Debug for AttachmentEncryptor<'a, R>

Available on non-tarpaulin_include only.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, R: Read + ?Sized + 'a> Read for AttachmentEncryptor<'a, R>

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

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

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>) -> 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 Self

where 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.