Enum Message 

#[repr(u8)]
pub enum Message {
    Hello(Hello),
    Connect {
        request_id: u64,
        metadata: Metadata,
    },
    Accept {
        request_id: u64,
        conn_id: ConnectionId,
        metadata: Metadata,
    },
    Reject {
        request_id: u64,
        reason: String,
        metadata: Metadata,
    },
    Goodbye {
        conn_id: ConnectionId,
        reason: String,
    },
    Request {
        conn_id: ConnectionId,
        request_id: u64,
        method_id: u64,
        metadata: Metadata,
        channels: Vec<u64>,
        payload: Vec<u8>,
    },
    Response {
        conn_id: ConnectionId,
        request_id: u64,
        metadata: Metadata,
        channels: Vec<u64>,
        payload: Vec<u8>,
    },
    Cancel {
        conn_id: ConnectionId,
        request_id: u64,
    },
    Data {
        conn_id: ConnectionId,
        channel_id: u64,
        payload: Vec<u8>,
    },
    Close {
        conn_id: ConnectionId,
        channel_id: u64,
    },
    Reset {
        conn_id: ConnectionId,
        channel_id: u64,
    },
    Credit {
        conn_id: ConnectionId,
        channel_id: u64,
        bytes: u32,
    },
}

Protocol message.

Variant order is wire-significant (postcard enum discriminants).

Virtual Connections (v2.0.0)

A link carries multiple virtual connections, each with its own request ID space, channel ID space, and dispatcher. Connection 0 is implicit on link establishment. Additional connections are opened via Connect/Accept/Reject.

All messages except Hello, Connect, Accept, and Reject include a conn_id field identifying which virtual connection they belong to.

Variants

Hello(Hello)

r[impl message.hello.timing] - Sent immediately after link establishment.

Connect

r[impl message.connect.initiate] - Request a new virtual connection.

Fields

request_id: u64

metadata: Metadata

Accept

r[impl message.accept.response] - Accept a virtual connection request.

Fields

request_id: u64

conn_id: ConnectionId

metadata: Metadata

Reject

r[impl message.reject.response] - Reject a virtual connection request.

Fields

request_id: u64

reason: String

metadata: Metadata

Goodbye

r[impl message.goodbye.send] - Close a virtual connection. r[impl message.goodbye.connection-zero] - Goodbye on conn 0 closes entire link.

Fields

conn_id: ConnectionId

reason: String

Request

r[impl core.metadata] - Request carries metadata key-value pairs. r[impl call.metadata.unknown] - Unknown keys are ignored. r[impl channeling.request.channels] - Channel IDs listed explicitly for proxy support.

Fields

conn_id: ConnectionId

request_id: u64

method_id: u64

metadata: Metadata

channels: Vec<u64>

Channel IDs used by this call, in argument declaration order. This is the authoritative source - servers MUST use these IDs, not any IDs that may be embedded in the payload.

payload: Vec<u8>

Response

r[impl core.metadata] - Response carries metadata key-value pairs. r[impl call.metadata.unknown] - Unknown keys are ignored.

Fields

conn_id: ConnectionId

request_id: u64

metadata: Metadata

channels: Vec<u64>

Channel IDs for streams in the response, in return type declaration order. Client uses these to bind receivers for incoming Data messages.

payload: Vec<u8>

Cancel

r[impl call.cancel.message] - Cancel message requests callee stop processing. r[impl call.cancel.no-response-required] - Caller should timeout, not wait indefinitely.

Fields

conn_id: ConnectionId

request_id: u64

Data

Fields

conn_id: ConnectionId

channel_id: u64

payload: Vec<u8>

Close

Fields

conn_id: ConnectionId

channel_id: u64

Reset

Fields

conn_id: ConnectionId

channel_id: u64

Credit

Fields

conn_id: ConnectionId

channel_id: u64

bytes: u32

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl<'ʄ> Facet<'ʄ> for Message

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?

impl PartialEq for Message

fn eq(&self, other: &Message) -> 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 Eq for Message

impl StructuralPartialEq for Message