Struct HelloEnvelope 

pub struct HelloEnvelope {
    pub kind: HelloKind,
    pub version: u32,
    pub identity: PeerIdentity,
}

Identity block sent once in each direction when a WebSocket link comes up (RFC 017 §8). Version 2 is the first with a structured identity field; version 1 is implicit in pre-RFC-017 code.

Fields

kind: HelloKind

Wire tag discriminating this frame from other possible envelopes.

version: u32

Version of the hello envelope schema. Must be >= 2.

identity: PeerIdentity

The sender’s identity block.

Implementations

impl HelloEnvelope

pub const CURRENT_VERSION: u32 = 2

The hello envelope schema version this build emits.

pub const MIN_SUPPORTED_VERSION: u32 = 2

The minimum hello envelope version this build will accept from a peer.

pub fn new(identity: PeerIdentity) -> Self

Construct a new hello envelope at Self::CURRENT_VERSION carrying identity.

Trait Implementations

impl Clone for HelloEnvelope

fn clone(&self) -> HelloEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelloEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HelloEnvelope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HelloEnvelope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.