Skip to main content

DecryptorBuilder

Struct DecryptorBuilder 

Source
pub struct DecryptorBuilder<'a> { /* private fields */ }
Expand description

A builder for Decryptor.

This allows the customization of Decryptor, which can be built using DecryptorBuilder::with_policy.

Implementations§

Source§

impl<'a> DecryptorBuilder<'a>

Source

pub fn buffer_size(self, size: usize) -> DecryptorBuilder<'a>

Changes the amount of buffered data.

By default, we buffer up to 25 megabytes of net message data (see DEFAULT_BUFFER_SIZE). This changes the default.

§Examples
use sequoia_openpgp as openpgp;
use openpgp::parse::{Parse, stream::*};
use openpgp::policy::StandardPolicy;

let p = &StandardPolicy::new();

struct Helper {}
impl VerificationHelper for Helper {
    // ...
}
impl DecryptionHelper for Helper {
    // ...
}

let message =
    // ...

let h = Helper {};
let mut v = DecryptorBuilder::from_bytes(message)?
    .buffer_size(1 << 12)
    .with_policy(p, None, h)?;
Source

pub fn mapping(self, enabled: bool) -> DecryptorBuilder<'a>

Enables mapping.

If mapping is enabled, the packet parser will create a Map of the packets that can be inspected in VerificationHelper::inspect. Note that this buffers the packets contents, and is not recommended unless you know that the packets are small.

§Examples
use sequoia_openpgp as openpgp;
use openpgp::parse::{Parse, stream::*};
use openpgp::policy::StandardPolicy;

let p = &StandardPolicy::new();

struct Helper {}
impl VerificationHelper for Helper {
    // ...
}
impl DecryptionHelper for Helper {
    // ...
}

let message =
    // ...

let h = Helper {};
let mut v = DecryptorBuilder::from_bytes(message)?
    .mapping(true)
    .with_policy(p, None, h)?;
Source

pub fn with_policy<T, H>( self, policy: &'a dyn Policy, time: T, helper: H, ) -> Result<Decryptor<'a, H>, Error>

Creates the Decryptor.

Signature verifications are done under the given policy and relative to time time, or the current time, if time is None. helper is the VerificationHelper and DecryptionHelper to use.

§Examples
use sequoia_openpgp as openpgp;
use openpgp::parse::{Parse, stream::*};
use openpgp::policy::StandardPolicy;

let p = &StandardPolicy::new();

struct Helper {}
impl VerificationHelper for Helper {
    // ...
}
impl DecryptionHelper for Helper {
    // ...
}

let message =
    // ...

let h = Helper {};
let mut v = DecryptorBuilder::from_bytes(message)?
    // Customize the `Decryptor` here.
    .with_policy(p, None, h)?;

Trait Implementations§

Source§

impl<'a> Parse<'a, DecryptorBuilder<'a>> for DecryptorBuilder<'a>

Source§

fn from_buffered_reader<R>(reader: R) -> Result<DecryptorBuilder<'a>, Error>
where R: BufferedReader<Cookie> + 'a,

Reads from the given buffered reader. Read more
Source§

fn from_reader<R>(reader: R) -> Result<T, Error>
where R: 'a + Read + Send + Sync,

Reads from the given reader. Read more
Source§

fn from_file<P>(path: P) -> Result<T, Error>
where P: AsRef<Path>,

Reads from the given file. Read more
Source§

fn from_bytes<D>(data: &'a D) -> Result<T, Error>
where D: AsRef<[u8]> + Send + Sync + ?Sized,

Reads from the given slice. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for DecryptorBuilder<'a>

§

impl<'a> !UnwindSafe for DecryptorBuilder<'a>

§

impl<'a> Freeze for DecryptorBuilder<'a>

§

impl<'a> Send for DecryptorBuilder<'a>

§

impl<'a> Sync for DecryptorBuilder<'a>

§

impl<'a> Unpin for DecryptorBuilder<'a>

§

impl<'a> UnsafeUnpin for DecryptorBuilder<'a>

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSend for T

Source§

impl<T> MaybeSync for T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more