Enum Frame 

pub enum Frame {
    Hello,
    Welcome {
        session_id: SessionId,
    },
    SessionRejected {
        code: ErrorCode,
        message: String,
    },
    Publish {
        request_id: u64,
        destination: Destination,
        access_token: BearerToken,
    },
    Published {
        request_id: u64,
        binding_id: BindingId,
    },
    PublishFailed {
        request_id: u64,
        code: ErrorCode,
        message: String,
    },
    Unpublish {
        request_id: u64,
        binding_id: BindingId,
    },
    Unpublished {
        request_id: u64,
    },
    Dial {
        connection_id: u64,
        destination: Destination,
        access_token: BearerToken,
    },
    Offer {
        pipe_id: PipeId,
        binding_id: BindingId,
        destination: Destination,
    },
    OfferAccepted {
        pipe_id: PipeId,
    },
    OfferRejected {
        pipe_id: PipeId,
        code: ErrorCode,
        message: String,
    },
    Opened {
        pipe_id: PipeId,
    },
    DialFailed {
        connection_id: u64,
        code: ErrorCode,
        observation: PeerObservation,
        message: String,
    },
    Data {
        pipe_id: PipeId,
        payload: Bytes,
    },
    Fin {
        pipe_id: PipeId,
    },
    Close {
        pipe_id: PipeId,
    },
    Reset {
        pipe_id: PipeId,
        code: ErrorCode,
        message: String,
    },
    Ping {
        nonce: u64,
    },
    Pong {
        nonce: u64,
    },
    Cancel {
        pipe_id: PipeId,
    },
}

Wire messages exchanged within one SDK–Gateway session.

Credentials are operation-scoped and appear only in Frame::Publish and Frame::Dial; application data remains opaque in Frame::Data.

Variants

Hello

Welcome

Fields

session_id: SessionId

SessionRejected

Fields

code: ErrorCode

message: String

Publish

Fields

request_id: u64

destination: Destination

access_token: BearerToken

Published

Fields

request_id: u64

binding_id: BindingId

PublishFailed

Fields

request_id: u64

code: ErrorCode

message: String

Unpublish

Fields

request_id: u64

binding_id: BindingId

Unpublished

Fields

request_id: u64

Dial

Fields

connection_id: u64

destination: Destination

access_token: BearerToken

Offer

Offers an incoming Pipe to the session that owns a selected binding.

Fields

pipe_id: PipeId

binding_id: BindingId

destination: Destination

OfferAccepted

Fields

pipe_id: PipeId

OfferRejected

Fields

pipe_id: PipeId

code: ErrorCode

message: String

Opened

Confirms that a Pipe is established for the dialing session.

Fields

pipe_id: PipeId

DialFailed

Fields

connection_id: u64

code: ErrorCode

observation: PeerObservation

message: String

Data

Fields

pipe_id: PipeId

payload: Bytes

Fin

Half-closes the sender’s write direction of a Pipe.

Fields

pipe_id: PipeId

Close

Closes a Pipe normally in both directions.

Fields

pipe_id: PipeId

Reset

Terminates a Pipe with an error.

Fields

pipe_id: PipeId

code: ErrorCode

message: String

Ping

Fields

nonce: u64

Pong

Fields

nonce: u64

Cancel

Cancels a pending Pipe establishment attempt.

Fields

pipe_id: PipeId

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, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encoder<Frame> for FrameCodec

type Error = ProtocolError

The type of encoding errors.

fn encode( &mut self, item: Frame, destination: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

impl Eq for Frame

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame