Enum StartProtocol 

pub enum StartProtocol<I, T, C> {
    StartSession(StartInitiation<T, C>),
    SessionEstablished(StartEstablished<I>),
    SessionError(StartErrorType),
    KeepAlive(KeepAliveMessage<I>),
}

Lists all messages of the Start protocol for a session establishment.

Generic parameters

• I is the session identifier.
• T is the session target.
• C are session capabilities.

Diagram of the protocol

sequenceDiagram Entry->>Exit: SessionInitiation (Challenge) alt If Exit can accept a new session Note right of Exit: SessionID [Pseudonym, Tag] Exit->>Entry: SessionEstablished (Challenge, SessionID_Entry) Note left of Entry: SessionID [Pseudonym, Tag] Entry->>Exit: KeepAlive (SessionID) Note over Entry,Exit: Data else If Exit cannot accept a new session Exit->>Entry: SessionError (Challenge, Reason) end opt If initiation attempt times out Note left of Entry: Failure end

Variants

StartSession(StartInitiation<T, C>)

Request to initiate a new session.

SessionEstablished(StartEstablished<I>)

Confirmation that a new session has been established by the counterparty.

SessionError(StartErrorType)

Counterparty could not establish a new session due to an error.

KeepAlive(KeepAliveMessage<I>)

A ping message to keep the session alive.

Implementations

impl<I, T, C> StartProtocol<I, T, C>

pub const START_PROTOCOL_MESSAGE_TAG: Tag

Fixed [Tag] of every protocol message.

pub const START_PROTOCOL_VERSION: u8 = 2u8

Current version of the Start protocol.

impl<I, T, C> StartProtocol<I, T, C>

where I: Serialize + for<'de> Deserialize<'de>, T: Serialize + for<'de> Deserialize<'de>, C: Into<u8> + TryFrom<u8>,

pub fn encode(self) -> Result<(Tag, Box<[u8]>)>

Tries to encode the message into binary format and [Tag]

pub fn decode(tag: Tag, data: &[u8]) -> Result<Self>

Tries to decode the message from the binary representation and [Tag].

The tag must be currently START_PROTOCOL_MESSAGE_TAG and version START_PROTOCOL_VERSION.

Trait Implementations

impl<I: Clone, T: Clone, C: Clone> Clone for StartProtocol<I, T, C>

fn clone(&self) -> StartProtocol<I, T, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug, T: Debug, C: Debug> Debug for StartProtocol<I, T, C>

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

Formats the value using the given formatter.

impl<'_enum, I, T, C> From<&'_enum StartProtocol<I, T, C>> for StartProtocolDiscriminants

fn from(val: &'_enum StartProtocol<I, T, C>) -> StartProtocolDiscriminants

Converts to this type from the input type.

impl<I, T, C> From<StartProtocol<I, T, C>> for StartProtocolDiscriminants

fn from(val: StartProtocol<I, T, C>) -> StartProtocolDiscriminants

Converts to this type from the input type.

impl<I, T, C> IntoDiscriminant for StartProtocol<I, T, C>

type Discriminant = StartProtocolDiscriminants

Enum listing the same variants as this enum but without any data fields

fn discriminant(&self) -> Self::Discriminant

impl<I: PartialEq, T: PartialEq, C: PartialEq> PartialEq for StartProtocol<I, T, C>

fn eq(&self, other: &StartProtocol<I, T, C>) -> 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<I, T, C> TryFrom<ApplicationData> for StartProtocol<I, T, C>

where I: Serialize + for<'de> Deserialize<'de>, T: Serialize + for<'de> Deserialize<'de>, C: Into<u8> + TryFrom<u8>,

type Error = StartProtocolError

The type returned in the event of a conversion error.

fn try_from(value: ApplicationData) -> Result<Self, Self::Error>

Performs the conversion.

impl<I, T, C> TryFrom<StartProtocol<I, T, C>> for ApplicationData

where I: Serialize + for<'de> Deserialize<'de>, T: Serialize + for<'de> Deserialize<'de>, C: Into<u8> + TryFrom<u8>,

type Error = StartProtocolError

The type returned in the event of a conversion error.

fn try_from(value: StartProtocol<I, T, C>) -> Result<Self, Self::Error>

Performs the conversion.

impl<I: Eq, T: Eq, C: Eq> Eq for StartProtocol<I, T, C>

impl<I, T, C> StructuralPartialEq for StartProtocol<I, T, C>