Enum StdMaybeCryptoFile 

pub enum StdMaybeCryptoFile<S: SimplexSecretBox> {
    Plain(File),
    Encrypted(EncryptedFile<S>),
}

Available on crate feature crypto only.

A sync file that is either plaintext or SimpleX-SecretBox encrypted.

Variants

Plain(File)

Encrypted(EncryptedFile<S>)

Implementations

impl<S: SimplexSecretBox> StdMaybeCryptoFile<S>

pub fn open<P: AsRef<Path>>( path: P, crypto_args: Option<FileCryptoArgs>, ) -> Result<Self>

Opens the file read+write so that Self::prepare_for_overwrite works. Use Self::open_read_only when write access is not needed or not available.

pub fn open_read_only<P: AsRef<Path>>( path: P, crypto_args: Option<FileCryptoArgs>, ) -> Result<Self>

pub fn create<P: AsRef<Path>>( path: P, crypto_args: Option<FileCryptoArgs>, ) -> Result<Self>

pub fn from_crypto_file(crypto_file: SxcCryptoFile) -> Result<Self>

pub fn from_crypto_file_read_only(crypto_file: SxcCryptoFile) -> Result<Self>

pub fn size_hint(&mut self) -> Result<usize>

pub fn crypto_args(&self) -> Option<&FileCryptoArgs>

pub fn prepare_for_overwrite(&mut self) -> Result<()>

pub fn put_auth_tag(self) -> Result<()>

Writes the AEAD auth tag for encrypted files; no-op for plain files.

Trait Implementations

impl<S: SimplexSecretBox> Read for StdMaybeCryptoFile<S>

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>

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

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

Reads all bytes until EOF in this source, appending them to buf.

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

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adapter 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.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

impl<S: SimplexSecretBox> Write for StdMaybeCryptoFile<S>

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

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

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Attempts to write an entire buffer into this writer.

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_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, args: Arguments<'_>) -> Result<(), Error>

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

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

where Self: Sized,

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