Struct HandshakeGate 

pub struct HandshakeGate { /* private fields */ }

Drives the per-connection handshake state machine.

Deliberately not Clone: the gate’s entire guarantee is that its state only ever moves forward for one connection. A copy of a completed gate would admit requests on a connection that never handshook, and a copy of an earlier state could be restored after a violation closed the original.

Implementations

impl HandshakeGate

pub fn new(supported: SupportedVersions) -> Self

A new gate for a connection that has not yet handshaken, accepting SupportedVersions::current.

pub fn is_complete(&self) -> bool

True once a handshake has been accepted.

pub fn accepted_version(&self) -> Option<ProtocolVersion>

The accepted protocol version, once the handshake has completed.

pub fn admit( &mut self, frame: &Frame, ) -> Result<HandshakeOutcome, HandshakeSequenceError>

Feed one inbound frame to the gate.

• Before completion, a Frame::Handshake is evaluated against the configured SupportedVersions and produces HandshakeOutcome::Accepted or HandshakeOutcome::Rejected.
• Before completion, any other frame kind is a sequence violation (Err(HandshakeSequenceError)) — the caller must never have dispatched it to request/subscribe/etc. handling; this call is what makes that guarantee enforceable rather than conventional.
• After completion, client→server frames (crate::frame::CLIENT_TO_SERVER_KINDS minus handshake) are admitted (HandshakeOutcome::Admitted). A stray second handshake is a sequence violation (the ADR fixes the handshake to “the first application frame”), and a server→client-only kind (response, handshake_ack, subscribe_ack, unsubscribe_ack, event) is a direction violation — it can never be a legal inbound frame on this gate — and closes the gate like any other protocol violation.

Trait Implementations

impl Debug for HandshakeGate

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

Formats the value using the given formatter.

impl Default for HandshakeGate

fn default() -> Self

Returns the “default value” for a type.