Struct savefile::CryptoWriter

pub struct CryptoWriter<'a> { /* fields omitted */ }

A cryptographic stream wrapper. Wraps a plain dyn Write, and itself implements Write, encrypting all data written.

Implementations

impl<'a> CryptoWriter<'a>

pub fn new(
    writer: &'a mut dyn Write,
    key_bytes: [u8; 32]
) -> Result<CryptoWriter<'a>, SavefileError>

Create a new CryptoWriter, wrapping the given Write . Encrypts using the given 32 byte cryptographic key. Crypto is 256 bit AES GCM

pub fn flush_final(self) -> Result<(), SavefileError>

Data is encrypted in chunks. Calling this unconditionally finalizes a chunk, actually emitting data to the underlying dyn Write. When later reading data, an entire chunk must be read from file before any plaintext is produced.

Trait Implementations

impl<'a> Drop for CryptoWriter<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Write for CryptoWriter<'a>

fn flush(&mut self) -> Result<(), Error>

Writes any non-written buffered bytes to the underlying stream. If this fails, there is no recovery. The buffered data will have been lost.

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

Write a buffer into this writer, returning how many bytes were written.

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

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

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