Skip to main content

Algorithm

Enum Algorithm

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

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

NtruPrimeSntrup761

FrodoKem640Aes

FrodoKem640Shake

FrodoKem976Aes

FrodoKem976Shake

FrodoKem1344Aes

FrodoKem1344Shake

MlKem512Ipd

MlKem768Ipd

MlKem1024Ipd

MlKem512

MlKem768

MlKem1024

Implementations§

impl Algorithm

pub fn is_enabled(self) -> bool

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

pub fn to_id(self) -> *const c_char

Provides a pointer to the id of the algorithm

For use with the FFI api methods

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§

impl Clone for Algorithm

fn clone(&self) -> Algorithm

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

impl Copy for Algorithm

impl Debug for Algorithm

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

Formats the value using the given formatter. Read more

impl Display for Algorithm

Available on crate feature std only.

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

Formats the value using the given formatter. Read more

impl Eq for Algorithm

impl Hash for Algorithm

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

impl PartialEq for Algorithm

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for Algorithm

impl TryFrom<Algorithm> for Kem

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

Auto Trait Implementations§

impl Freeze for Algorithm

impl RefUnwindSafe for Algorithm

impl Send for Algorithm

impl Sync for Algorithm

impl Unpin for Algorithm

impl UnsafeUnpin for Algorithm

impl UnwindSafe for Algorithm

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.