Enum Frame 

pub enum Frame {
    Open {
        session: SessionId,
        service: String,
    },
    Data {
        session: SessionId,
        from_opener: bool,
        bytes: Bytes,
    },
    Shutdown {
        session: SessionId,
        from_opener: bool,
    },
    Close {
        session: SessionId,
        from_opener: bool,
    },
}

The relay’s overlay wire message — the payload carried under a transport namespace.

One vocabulary for both kinds (TCP connections and UDP flows):

  Open(session, service) → Data(session, bytes)* → Close(session)

Open is always sent by the session’s opener. Data/Shutdown/Close flow in both directions over the same opener-assigned id, so they carry from_opener — whether the sender of this frame opened the session. The receiver flips it to recover its own Initiator, so a peer’s session never collides with one of ours sharing the same id.

Variants

Open

Open a session/flow to a named local service (always sent by the opener).

Fields

session: SessionId

Session identifier (assigned by the opener).

service: String

Local service name to connect to.

Data

Bytes on an open session (one datagram per frame for UDP).

Fields

session: SessionId

Session the bytes belong to.

from_opener: bool

Whether the sender of this frame opened the session.

bytes: Bytes

Payload bytes.

Shutdown

Half-close: the sender has no more Data this direction (a TCP FIN). The receiver shuts down its local write side but keeps the reverse direction open. Ignored by UDP (datagram flows have no half-close).

Fields

session: SessionId

Session being half-closed.

from_opener: bool

Whether the sender of this frame opened the session.

Close

Close a session/flow (full teardown, both directions).

Fields

session: SessionId

Session to close.

from_opener: bool

Whether the sender of this frame opened the session.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Frame

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Frame

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

where __S: Serializer,

Serialize this value into the given Serde serializer.