Struct EncapsulationKey

pub struct EncapsulationKey { /* private fields */ }

Available on crate feature dep_orion only.

A type to represent the public EncapsulationKey that X-Wing uses.

This type simply holds bytes and performs no checks whatsoever. If a invalid ML-KEM-768 is part of the bytes parsed from this type, the check will first surface when encapsulation is performed.

Errors:

An error will be returned if:

• slice is not 1216 bytes.

Implementations

impl EncapsulationKey

pub fn from_slice(slice: &[u8]) -> Result<EncapsulationKey, UnknownCryptoError>

Construct from a given byte slice.

pub fn len(&self) -> usize

Return the length of the object.

pub fn is_empty(&self) -> bool

Return true if this object does not hold any data, false otherwise.

NOTE: This method should always return false, since there shouldn’t be a way to create an empty instance of this object.

Trait Implementations

impl AsRef<[u8]> for EncapsulationKey

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for EncapsulationKey

fn clone(&self) -> EncapsulationKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EncapsulationKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EncapsulationKey

This type tries to deserialize as a Vec<u8> would. If it succeeds, the digest will be built using Self::from_slice.

Note that this allocates once to store the referenced bytes on the heap.

fn deserialize<D>( deserializer: D, ) -> Result<EncapsulationKey, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<[u8; 1216]> for EncapsulationKey

fn from(bytes: [u8; 1216]) -> EncapsulationKey

Make an object from a byte array.

impl PartialEq<&[u8]> for EncapsulationKey

fn eq(&self, other: &&[u8]) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for EncapsulationKey

fn eq(&self, other: &EncapsulationKey) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for EncapsulationKey

This type tries to serialize as a &[u8] would. Note that the serialized type likely does not have the same protections that Orion provides, such as constant-time operations. A good rule of thumb is to only serialize these types for storage. Don’t operate on the serialized types.

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for EncapsulationKey

Delegates to from_slice implementation

type Error = UnknownCryptoError

The type returned in the event of a conversion error.

fn try_from( slice: &[u8], ) -> Result<EncapsulationKey, <EncapsulationKey as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl Copy for EncapsulationKey

impl Eq for EncapsulationKey