Enum NkeyType 

pub enum NkeyType {
    Account,
    Cluster,
    Server,
    Operator,
    User,
    Curve,
}

The role of a public NATS NKey, identified by its single base32 prefix letter (the first character of an encoded key string).

Wire derivation

A public key’s wire form is prefix_byte || 32-byte key || crc16, base32 encoded. base32 packs 5 bits per output character, so the first character is exactly the top 5 bits of prefix_byte. NATS chooses the role value so that first character is the role letter: prefix_byte = base32_index(letter) << 3, which lands the letter’s 5-bit alphabet index in the high 5 bits and leaves the low 3 bits zero. Those 3 bits just roll into the second base32 character with the top 2 bits of the key. (base32 alphabet ABCDEFGHIJKLMNOPQRSTUVWXYZ234567: A=0 C=2 N=13 O=14 U=20 X=23.)

(SEED keys look different, SU/SA/SO, because a seed is not role << 3: it OR-packs an S marker with the role and spills the role’s low bits into a second header byte. Only public keys are encoded here, so the simple role << 3 form holds.)

Variants

Account

Account key (A…).

Cluster

Cluster key (C…).

Server

Server key (N…).

Operator

Operator key (O…).

User

User key (U…).

Curve

Curve / x25519 (xkey) key (X…); also NATS’s catch-all role.

Implementations

impl NkeyType

pub const fn letter(self) -> char

The role’s NKey prefix letter (the first character of an encoded key).

pub const fn prefix_byte(self) -> u8

The wire prefix byte (base32_index(letter) << 3) this role encodes to.

pub fn from_letter(letter: char) -> Option<Self>

Parse a role from its prefix letter, or None if letter is not one of the supported public roles (A/C/N/O/U/X).

Trait Implementations

impl Clone for NkeyType

fn clone(&self) -> NkeyType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for NkeyType

impl Debug for NkeyType

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

Formats the value using the given formatter.

impl Display for NkeyType

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

Formats the value using the given formatter.

impl Eq for NkeyType

impl Hash for NkeyType

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 NkeyType

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