Decryptor

Struct Decryptor 

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

Decryptor for an age file.

Implementations§

Source§

impl<R> Decryptor<R>
where R: Read,

Source

pub fn new(input: R) -> Result<Decryptor<R>, 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.

Source

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.

Source§

impl<R> Decryptor<R>
where R: BufRead,

Source

pub fn new_buffered(input: R) -> Result<Decryptor<R>, 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.

Source§

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

Source

pub async fn new_async(input: R) -> Result<Decryptor<R>, 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 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.

Source

pub fn decrypt_async<'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.

Source§

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

Source

pub async fn new_async_buffered(input: R) -> Result<Decryptor<R>, 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_async for types implementing AsyncBufRead, which includes &[u8] slices.

Auto Trait Implementations§

§

impl<R> Freeze for Decryptor<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for Decryptor<R>
where R: RefUnwindSafe,

§

impl<R> Send for Decryptor<R>
where R: Send,

§

impl<R> Sync for Decryptor<R>
where R: Sync,

§

impl<R> Unpin for Decryptor<R>
where R: Unpin,

§

impl<R> UnwindSafe for Decryptor<R>
where R: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V