Skip to main content

SignedEnvelope

Struct SignedEnvelope 

Source
pub struct SignedEnvelope<'a, T> { /* private fields */ }
Expand description

Payload paired with a signature envelope.

Implementations§

Source§

impl<'a, T> SignedEnvelope<'a, T>

Source

pub const fn new(payload: T, signature: SignatureEnvelope<'a>) -> Self

Creates a signed envelope from a payload and validated signature metadata.

Source

pub fn verify_detached_bytes<V: Verifier>( &self, verifier: &V, algorithm_policy: &AlgorithmPolicy<'_>, canonical_payload: &[u8], limits: WireLimits, ) -> Result<(), VerificationError>

Verifies a detached canonical byte representation of this envelope.

The caller must ensure canonical_payload is the exact canonical encoding of self.payload(). BCX will replace this detached helper with typed canonical encoding once bcx-codec is introduced.

Source

pub const fn payload(&self) -> &T

Returns the payload value.

Source

pub const fn signature(&self) -> SignatureEnvelope<'a>

Returns the signature envelope.

Trait Implementations§

Source§

impl<'a, T: Clone> Clone for SignedEnvelope<'a, T>

Source§

fn clone(&self) -> SignedEnvelope<'a, T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a, T: Copy> Copy for SignedEnvelope<'a, T>

Source§

impl<'a, T: Debug> Debug for SignedEnvelope<'a, T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, T: Eq> Eq for SignedEnvelope<'a, T>

Source§

impl<'a, T: PartialEq> PartialEq for SignedEnvelope<'a, T>

Source§

fn eq(&self, other: &SignedEnvelope<'a, T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a, T: PartialEq> StructuralPartialEq for SignedEnvelope<'a, T>

Auto Trait Implementations§

§

impl<'a, T> Freeze for SignedEnvelope<'a, T>
where T: Freeze,

§

impl<'a, T> RefUnwindSafe for SignedEnvelope<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for SignedEnvelope<'a, T>
where T: Send,

§

impl<'a, T> Sync for SignedEnvelope<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for SignedEnvelope<'a, T>
where T: Unpin,

§

impl<'a, T> UnsafeUnpin for SignedEnvelope<'a, T>
where T: UnsafeUnpin,

§

impl<'a, T> UnwindSafe for SignedEnvelope<'a, T>
where T: 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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, 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.