Enum ClientEnvelope 

pub enum ClientEnvelope {
    Message(ClientMessage),
    Request {
        request_id: RequestId,
        request: ClientRequest,
    },
    Response {
        response_to: RequestId,
        response: ClientResponse,
    },
}

Variants

Message(ClientMessage)

Request

Fields

request_id: RequestId

request: ClientRequest

Response

Fields

response_to: RequestId

response: ClientResponse

Implementations

impl ClientEnvelope

pub fn into_envelope(self) -> Result<Envelope, Error>

encode one typed client-side envelope into the websocket wire shape

Errors

Returns serde_json::Error when the typed payload cannot be serialized into the JSON envelope payload.

pub fn decode(envelope: Envelope) -> Result<Self, EnvelopeDecodeError>

decode a raw websocket envelope into the typed native client contract

Errors

Returns EnvelopeDecodeError::UnknownTag when the tag is unknown for its route, EnvelopeDecodeError::InvalidPayload when a required payload is missing or malformed and EnvelopeDecodeError::UnexpectedPayload when a payload is supplied for stoprecording.

Trait Implementations

impl Clone for ClientEnvelope

fn clone(&self) -> ClientEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientEnvelope

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

Formats the value using the given formatter.

impl PartialEq for ClientEnvelope

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

impl StructuralPartialEq for ClientEnvelope