Enum Algorithm 

pub enum Algorithm {
    MlKem(MlKem),
    MlDsa(MlDsa),
    SlhDsa(SlhDsa),
}

A unified enum representing any supported PQ algorithm.

This provides a single type that can represent any algorithm from any family, useful for generic processing.

Example

use pq_oid::{Algorithm, MlKem, MlDsa};
use std::str::FromStr;

let alg = Algorithm::from_str("ML-KEM-512").unwrap();
assert_eq!(alg.oid(), "2.16.840.1.101.3.4.4.1");

// Convert from family-specific enums
let alg: Algorithm = MlDsa::Dsa65.into();
assert_eq!(alg.as_str(), "ML-DSA-65");

Variants

MlKem(MlKem)

MlDsa(MlDsa)

SlhDsa(SlhDsa)

Implementations

impl Algorithm

pub const COUNT: usize = 18

Total number of supported algorithms.

pub const KEM_COUNT: usize = MlKem::COUNT

Number of KEM algorithms.

pub const SIGNATURE_COUNT: usize

Number of signing algorithms.

pub const ALL: &'static [Algorithm]

All supported algorithms (18 total).

pub const ALL_KEMS: &'static [Algorithm]

All KEM algorithms.

pub const ALL_SIGNATURES: &'static [Algorithm]

All signing algorithms.

pub fn all() -> impl Iterator<Item = Algorithm>

Returns an iterator over all supported algorithms.

pub fn kems() -> impl Iterator<Item = Algorithm>

Returns an iterator over all KEM algorithms.

pub fn signatures() -> impl Iterator<Item = Algorithm>

Returns an iterator over all signing algorithms.

pub const fn as_str(&self) -> &'static str

Returns the algorithm name string.

pub const fn oid(&self) -> &'static str

Returns the OID in dotted notation.

pub const fn algorithm_type(&self) -> AlgorithmType

Returns the algorithm type.

pub const fn family(&self) -> AlgorithmFamily

Returns the algorithm family.

pub const fn security_level(&self) -> SecurityLevel

Returns the NIST security level.

pub const fn public_key_size(&self) -> usize

Returns the public key size in bytes.

pub const fn private_key_size(&self) -> usize

Returns the private key size in bytes.

pub const fn info(&self) -> AlgorithmInfo

Returns the complete algorithm info.

pub fn from_oid(oid: &str) -> Result<Algorithm, Error>

Parse from an OID string.

pub const fn as_ml_kem(&self) -> Option<MlKem>

Returns this as an MlKem if it is one.

pub const fn as_ml_dsa(&self) -> Option<MlDsa>

Returns this as an MlDsa if it is one.

pub const fn as_slh_dsa(&self) -> Option<SlhDsa>

Returns this as an SlhDsa if it is one.

Trait Implementations

impl AsRef<str> for Algorithm

fn as_ref(&self) -> &str

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

impl Clone for Algorithm

fn clone(&self) -> Algorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Algorithm

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

Formats the value using the given formatter.

impl Display for Algorithm

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

Formats the value using the given formatter.

impl From<MlDsa> for Algorithm

fn from(a: MlDsa) -> Algorithm

Converts to this type from the input type.

impl From<MlKem> for Algorithm

fn from(a: MlKem) -> Algorithm

Converts to this type from the input type.

impl From<SlhDsa> for Algorithm

fn from(a: SlhDsa) -> Algorithm

Converts to this type from the input type.

impl FromStr for Algorithm

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Algorithm, Error>

Parses a string s to return a value of this type.

impl Hash for Algorithm

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Algorithm

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Algorithm, Error>

Performs the conversion.

impl Copy for Algorithm

impl Eq for Algorithm

impl StructuralPartialEq for Algorithm