oqs::kem

Enum Algorithm

source
pub enum Algorithm {
Show 29 variants BikeL1, BikeL3, BikeL5, ClassicMcEliece348864, ClassicMcEliece348864f, ClassicMcEliece460896, ClassicMcEliece460896f, ClassicMcEliece6688128, ClassicMcEliece6688128f, ClassicMcEliece6960119, ClassicMcEliece6960119f, ClassicMcEliece8192128, ClassicMcEliece8192128f, Hqc128, Hqc192, Hqc256, Kyber512, Kyber768, Kyber1024, MlKem512, MlKem768, MlKem1024, NtruPrimeSntrup761, FrodoKem640Aes, FrodoKem640Shake, FrodoKem976Aes, FrodoKem976Shake, FrodoKem1344Aes, FrodoKem1344Shake,
}
Expand description

Supported algorithms by OQS

Note that this doesn’t mean that they’ll be available.

Optional support for serde if that feature is enabled.

Variants§

§

BikeL1

§

BikeL3

§

BikeL5

§

ClassicMcEliece348864

§

ClassicMcEliece348864f

§

ClassicMcEliece460896

§

ClassicMcEliece460896f

§

ClassicMcEliece6688128

§

ClassicMcEliece6688128f

§

ClassicMcEliece6960119

§

ClassicMcEliece6960119f

§

ClassicMcEliece8192128

§

ClassicMcEliece8192128f

§

Hqc128

§

Hqc192

§

Hqc256

§

Kyber512

§

Kyber768

§

Kyber1024

§

MlKem512

§

MlKem768

§

MlKem1024

§

NtruPrimeSntrup761

§

FrodoKem640Aes

§

FrodoKem640Shake

§

FrodoKem976Aes

§

FrodoKem976Shake

§

FrodoKem1344Aes

§

FrodoKem1344Shake

Implementations§

source§

impl Algorithm

source

pub fn is_enabled(self) -> bool

Returns true if this algorithm is enabled in the linked version of liboqs

source

pub fn to_id(self) -> *const c_char

Provides a pointer to the id of the algorithm

For use with the FFI api methods

source

pub fn name(&self) -> &'static str

Returns the algorithm’s name as a static Rust string.

This is the same as the to_id, but as a safe Rust string.

Trait Implementations§

source§

impl Clone for Algorithm

source§

fn clone(&self) -> Algorithm

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 Debug for Algorithm

source§

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

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

impl<'de> Deserialize<'de> for Algorithm

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for Algorithm

source§

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

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

impl Hash for Algorithm

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for Algorithm

source§

fn eq(&self, other: &Algorithm) -> 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 Serialize for Algorithm

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl TryFrom<Algorithm> for Kem

source§

type Error = Error

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

fn try_from(alg: Algorithm) -> Result<Kem>

Performs the conversion.
source§

impl Copy for Algorithm

source§

impl Eq for Algorithm

source§

impl StructuralPartialEq for Algorithm

Auto Trait Implementations§

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, 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> ToOwned for T
where T: Clone,

source§

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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,