Struct ml_kem::kem::DecapsulationKey

source ·
pub struct DecapsulationKey<P>
where P: KemParams,
{ /* private fields */ }
Expand description

A DecapsulationKey provides the ability to generate a new key pair, and decapsulate an encapsulated shared key.

Implementations§

source§

impl<P> DecapsulationKey<P>
where P: KemParams,

source

pub fn encapsulation_key(&self) -> &EncapsulationKey<P>

Get the EncapsulationKey which corresponds to this DecapsulationKey.

Trait Implementations§

source§

impl<P> Clone for DecapsulationKey<P>
where P: KemParams + Clone,

source§

fn clone(&self) -> DecapsulationKey<P>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<P> Debug for DecapsulationKey<P>
where P: KemParams + Debug,

source§

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

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

impl<P> Decapsulate<Array<u8, <P as PkeParams>::CiphertextSize>, Array<u8, UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>>> for DecapsulationKey<P>
where P: KemParams,

§

type Error = ()

Decapsulation error
source§

fn decapsulate( &self, encapsulated_key: &Array<u8, <P as PkeParams>::CiphertextSize>, ) -> Result<B32, ()>

Decapsulates the given encapsulated key
source§

impl<P> Drop for DecapsulationKey<P>
where P: KemParams,

Available on crate feature zeroize only.
source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<P> EncodedSizeUser for DecapsulationKey<P>
where P: KemParams,

§

type EncodedSize = <P as KemParams>::DecapsulationKeySize

The size of an encoded object
source§

fn from_bytes(enc: &Encoded<Self>) -> Self

Parse an object from its encoded form
source§

fn as_bytes(&self) -> Encoded<Self>

Serialize an object to its encoded form
source§

impl<P> PartialEq for DecapsulationKey<P>
where P: KemParams + PartialEq,

source§

fn eq(&self, other: &DecapsulationKey<P>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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<P> StructuralPartialEq for DecapsulationKey<P>
where P: KemParams,

source§

impl<P> ZeroizeOnDrop for DecapsulationKey<P>
where P: KemParams,

Available on crate feature zeroize only.

Auto Trait Implementations§

§

impl<P> Freeze for DecapsulationKey<P>
where <<P as ParameterSet>::K as ArraySize>::ArrayType<NttPolynomial>: Freeze,

§

impl<P> RefUnwindSafe for DecapsulationKey<P>
where <<P as ParameterSet>::K as ArraySize>::ArrayType<NttPolynomial>: RefUnwindSafe,

§

impl<P> Send for DecapsulationKey<P>

§

impl<P> Sync for DecapsulationKey<P>

§

impl<P> Unpin for DecapsulationKey<P>
where <<P as ParameterSet>::K as ArraySize>::ArrayType<NttPolynomial>: Unpin,

§

impl<P> UnwindSafe for DecapsulationKey<P>
where <<P as ParameterSet>::K as ArraySize>::ArrayType<NttPolynomial>: 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§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

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

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

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>,

§

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.