Enum PeerState 

#[non_exhaustive]
pub enum PeerState {
    Bootstrapped {
        versions_url: Url,
        token_a: CredentialsToken,
    },
    Registered {
        version: VersionNumber,
        our_token_for_them: CredentialsToken,
        their_token_for_us: CredentialsToken,
        parties: Vec<PartyRef>,
    },
    Unregistered,
}

Available on crate feature client only.

Where a connection with one peer stands.

The transitions between these are the ones the specification defines; storing this enum is how a process remembers a registration across restarts.

Spec: 2.3.0 §credentials_use_cases

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.

Bootstrapped

CREDENTIALS_TOKEN_A has been exchanged out of band; nothing else has happened.

The token may only be used on the credentials and versions modules.

Fields

versions_url: Url

The peer’s versions endpoint.

token_a: CredentialsToken

CREDENTIALS_TOKEN_A.

Registered

The handshake completed.

Fields

version: VersionNumber

The version in use.

our_token_for_them: CredentialsToken

The token this party uses to call the peer (CREDENTIALS_TOKEN_C for the Sender).

their_token_for_us: CredentialsToken

The token the peer uses to call this party (CREDENTIALS_TOKEN_B for the Sender).

parties: Vec<PartyRef>

The parties the peer speaks for.

Unregistered

A DELETE on the credentials module ended the connection.

Both parties must end any automated communication.

Implementations

impl PeerState

pub const fn may_use_functional_modules(&self) -> bool

Whether requests to functional modules are allowed in this state.

Only a registered peer may be called for anything other than credentials and versions.

pub const fn accepts_credentials_post(&self) -> bool

Whether a credentials POST is the right method in this state.

This method MUST return a HTTP status code 405: method not allowed if the client has already been registered before.

pub const fn accepts_credentials_put_or_delete(&self) -> bool

Whether a credentials PUT or DELETE is the right method in this state.

This method MUST return a HTTP status code 405: method not allowed if the client has not been registered yet.

Trait Implementations

impl Clone for PeerState

fn clone(&self) -> PeerState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PeerState

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

Formats the value using the given formatter.

impl PartialEq for PeerState

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PeerState