Struct Decryptor 

pub struct Decryptor<R> { /* private fields */ }

Decryptor for an age file.

Implementations

impl<R> Decryptor<R>

pub fn is_scrypt(&self) -> bool

Returns true if the age file is encrypted to a passphrase.

impl<R: Read> Decryptor<R>

pub fn new(input: R) -> Result<Self, DecryptError>

Attempts to create a decryptor for an age file.

Returns an error if the input does not contain a valid age file.

Performance

This constructor will work with any type implementing io::Read, and uses a slower parser and internal buffering to ensure no overreading occurs. Consider using Decryptor::new_buffered for types implementing std::io::BufRead, which includes &[u8] slices.

pub fn decrypt<'a>( self, identities: impl Iterator<Item = &'a dyn Identity>, ) -> Result<StreamReader<R>, DecryptError>

Attempts to decrypt the age file.

If successful, returns a reader that will provide the plaintext.

impl<R: BufRead> Decryptor<R>

pub fn new_buffered(input: R) -> Result<Self, DecryptError>

Attempts to create a decryptor for an age file.

Returns an error if the input does not contain a valid age file.

Performance

This constructor is more performant than Decryptor::new for types implementing io::BufRead, which includes &[u8] slices.

impl<R: AsyncRead + Unpin> Decryptor<R>

pub async fn new_async(input: R) -> Result<Self, DecryptError>

Available on crate feature async only.

Attempts to create a decryptor for an age file.

Returns an error if the input does not contain a valid age file.

Performance

This constructor will work with any type implementing AsyncRead, and uses a slower parser and internal buffering to ensure no overreading occurs. Consider using Decryptor::new_async_buffered for types implementing AsyncBufRead, which includes &[u8] slices.

pub fn decrypt_async<'a>( self, identities: impl Iterator<Item = &'a dyn Identity>, ) -> Result<StreamReader<R>, DecryptError>

Available on crate feature async only.

Attempts to decrypt the age file.

If successful, returns a reader that will provide the plaintext.

impl<R: AsyncBufRead + Unpin> Decryptor<R>

pub async fn new_async_buffered(input: R) -> Result<Self, DecryptError>

Available on crate feature async only.

Attempts to create a decryptor for an age file.

Returns an error if the input does not contain a valid age file.

Performance

This constructor is more performant than Decryptor::new_async for types implementing AsyncBufRead, which includes &[u8] slices.