Struct lib_gistit::file::EncryptedFile

pub struct EncryptedFile { /* fields omitted */ }

Represents a encrypted gistit file data. This data structure is expected to hold encrypted but not encoded bytes in encrypted_bytes, the nonce which is a 12 bytes randomly generated byte array, and a pointer to the previous unencrypted File handler.

Implementations

impl EncryptedFile

pub async fn from_bytes_encoded(
    encoded_bytes: &[u8],
    name: &str
) -> Result<Self>

Creates a new EncryptedFile handler from encrypted and encoded byte array. That means it should contain the expected encryption header and be base64 encoded.

Will create a new temporary file in your system temp directory and write decoded and still encrypted contents into it.

note that there is no prev unencrypted File handler

Errors

Fails with IoError if can’t create or write to the file handler. Fails with FileError if the encryption header is invalid.

pub fn with_name(self, name: String) -> Self

Set a file name, if attempt to decrypt without a file name this will be set to a random string.

pub async fn into_decrypted(self, secret: &str) -> Result<File>

Converts Self into File handler by applying the decryption process with the provided secret.

Errors

Fails with EncryptionError if nonce or secret is incorrect

Trait Implementations

impl Debug for EncryptedFile

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

Formats the value using the given formatter.

impl FileReady for EncryptedFile

fn inner<'async_trait>(
    self: Box<Self>
) -> Pin<Box<dyn Future<Output = Option<Box<File>>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Returns a reference to the original File handler if any.

fn data(&self) -> &[u8]

Returns a reference to the underlying data. Can be encrypted depending on the source

fn to_encoded_data(&self) -> EncodedFileData

Converts Self into the sendable form of the data