Enum Algorithm

pub enum Algorithm {
Show 42 variants    CrossRsdp128Balanced,
    CrossRsdp128Fast,
    CrossRsdp128Small,
    CrossRsdp192Balanced,
    CrossRsdp192Fast,
    CrossRsdp192Small,
    CrossRsdp256Balanced,
    CrossRsdp256Fast,
    CrossRsdp256Small,
    CrossRsdpg128Balanced,
    CrossRsdpg128Fast,
    CrossRsdpg128Small,
    CrossRsdpg192Balanced,
    CrossRsdpg192Fast,
    CrossRsdpg192Small,
    CrossRsdpg256Balanced,
    CrossRsdpg256Fast,
    CrossRsdpg256Small,
    Dilithium2,
    Dilithium3,
    Dilithium5,
    Falcon512,
    Falcon1024,
    Mayo1,
    Mayo2,
    Mayo3,
    Mayo5,
    MlDsa44,
    MlDsa65,
    MlDsa87,
    SphincsSha2128fSimple,
    SphincsSha2128sSimple,
    SphincsSha2192fSimple,
    SphincsSha2192sSimple,
    SphincsSha2256fSimple,
    SphincsSha2256sSimple,
    SphincsShake128fSimple,
    SphincsShake128sSimple,
    SphincsShake192fSimple,
    SphincsShake192sSimple,
    SphincsShake256fSimple,
    SphincsShake256sSimple,
}

Expand description

Supported algorithms by liboqs

They may not all be enabled

Optional support for serde if that feature is enabled.

Variants§

CrossRsdp128Balanced

CrossRsdp128Fast

CrossRsdp128Small

CrossRsdp192Balanced

CrossRsdp192Fast

CrossRsdp192Small

CrossRsdp256Balanced

CrossRsdp256Fast

CrossRsdp256Small

CrossRsdpg128Balanced

CrossRsdpg128Fast

CrossRsdpg128Small

CrossRsdpg192Balanced

CrossRsdpg192Fast

CrossRsdpg192Small

CrossRsdpg256Balanced

CrossRsdpg256Fast

CrossRsdpg256Small

Dilithium2

Dilithium3

Dilithium5

Falcon512

Falcon1024

Mayo1

Mayo2

Mayo3

Mayo5

MlDsa44

MlDsa65

MlDsa87

SphincsSha2128fSimple

SphincsSha2128sSimple

SphincsSha2192fSimple

SphincsSha2192sSimple

SphincsSha2256fSimple

SphincsSha2256sSimple

SphincsShake128fSimple

SphincsShake128sSimple

SphincsShake192fSimple

SphincsShake192sSimple

SphincsShake256fSimple

SphincsShake256sSimple

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 copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Algorithm

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

Formats the value using the given formatter. Read more

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

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

Deserialize this value from the given Serde deserializer. Read more

impl Display for Algorithm

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

Formats the value using the given formatter. Read more

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

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.

impl Serialize for Algorithm

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

Serialize this value into the given Serde serializer. Read more

impl TryFrom<Algorithm> for Sig

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Algorithm

impl Eq for Algorithm

impl StructuralPartialEq for Algorithm

Auto Trait Implementations§

impl Freeze for Algorithm

impl RefUnwindSafe for Algorithm

impl Send for Algorithm

impl Sync for Algorithm

impl Unpin 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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. 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,

default 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 = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,