Enum HandshakePattern

pub enum HandshakePattern {
    N,
    X,
    K,
    NN,
    NK,
    NX,
    XN,
    XK,
    XX,
    KN,
    KK,
    KX,
    IN,
    IK,
    IX,
    NK1,
    NX1,
    X1N,
    X1K,
    XK1,
    X1K1,
    X1X,
    XX1,
    X1X1,
    K1N,
    K1K,
    KK1,
    K1K1,
    K1X,
    KX1,
    K1X1,
    I1N,
    I1K,
    IK1,
    I1K1,
    I1X,
    IX1,
    I1X1,
}

One of the patterns as defined in the Handshake Pattern section.

Variants

N

X

K

NN

NK

NX

XN

XK

XX

KN

KK

KX

IN

IK

IX

NK1

NX1

X1N

X1K

XK1

X1K1

X1X

XX1

X1X1

K1N

K1K

KK1

K1K1

K1X

KX1

K1X1

I1N

I1K

IK1

I1K1

I1X

IX1

I1X1

Implementations

impl HandshakePattern

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

The equivalent of the ToString trait, but for &'static str.

impl HandshakePattern

pub fn is_oneway(self) -> bool

If the protocol is one-way only

See: https://noiseprotocol.org/noise.html#one-way-handshake-patterns

pub fn needs_local_static_key(self, initiator: bool) -> bool

Whether this pattern requires a long-term static key.

pub fn need_known_remote_pubkey(self, initiator: bool) -> bool

Whether this pattern demands a remote public key pre-message.

Trait Implementations

impl Clone for HandshakePattern

fn clone(&self) -> HandshakePattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HandshakePattern

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

Formats the value using the given formatter.

impl FromStr for HandshakePattern

type Err = Error

The associated error which can be returned from parsing.

fn from_str( s: &str, ) -> Result<HandshakePattern, <HandshakePattern as FromStr>::Err>

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

impl PartialEq for HandshakePattern

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

Tests for self and other values to be equal, and is used by ==.

const 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 Copy for HandshakePattern

impl StructuralPartialEq for HandshakePattern