Enum PeerKeyAlgorithm 

#[non_exhaustive]
pub enum PeerKeyAlgorithm {
    Ed25519,
    Other(String),
}

Which algorithm a bound PeerKey’s bytes belong to.

cheers is a general auth library, so the field on Claims must not name one curve. The discriminant rides next to the bytes instead, and a key only ever matches another key of the same algorithm — so a byte string that is a valid public key under two schemes can’t be confused across them.

Other is the escape hatch for a scheme cheers hasn’t named: unknown labels still round-trip and still compare, so a consumer isn’t version-locked to a cheers release to bind a key type of its own. Labels are canonicalized on the way in (from_wire returns Ed25519 for "ed25519", never Other("ed25519")), so each algorithm has exactly one representation and equality is total.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Ed25519

Ed25519 — 32-byte public key. What iroh/QUIC node identities use.

Other(String)

A scheme cheers doesn’t name. Carries the wire label verbatim.

Implementations

impl PeerKeyAlgorithm

pub fn as_wire(&self) -> &str

The wire label. Stable — it is the serialized form.

pub fn from_wire(s: &str) -> Result<Self, PeerKeyError>

Parse a wire label, canonicalizing known ones onto their named variant.

pub fn expected_key_len(&self) -> Option<usize>

The exact key length this algorithm requires, when it has one. None for Other — cheers can’t police a scheme it doesn’t know.

Trait Implementations

impl Clone for PeerKeyAlgorithm

fn clone(&self) -> PeerKeyAlgorithm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PeerKeyAlgorithm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PeerKeyAlgorithm

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

Deserialize this value from the given Serde deserializer.

impl Display for PeerKeyAlgorithm

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

Formats the value using the given formatter.

impl Eq for PeerKeyAlgorithm

impl Hash for PeerKeyAlgorithm

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

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 PeerKeyAlgorithm

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PeerKeyAlgorithm

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PeerKeyAlgorithm