Enum WsServerFrame 

#[non_exhaustive]
pub enum WsServerFrame {
    Response(WsResponseFrame),
    Push(WsPushFrame),
    AuthOk(Option<WsAuthOk>),
    AuthFailed(ApiError),
}

Any frame the server sends, decoded by the same rules as the client (see the module docs). Use WsServerFrame::parse on a text frame.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Response(WsResponseFrame)

The answer to a request.

Push(WsPushFrame)

A push.

AuthOk(Option<WsAuthOk>)

First-message authentication accepted (data is optional on the wire: the client only looks at the type).

AuthFailed(ApiError)

First-message authentication refused; the server closes with 4001.

Implementations

impl WsServerFrame

pub fn parse(text: &str) -> Result<Self, Error>

Decode a text frame. An error means the frame is not part of the protocol (the client ignores such frames).

pub fn to_json(&self) -> Result<String, Error>

Encode as JSON text.

Trait Implementations

impl Clone for WsServerFrame

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsServerFrame

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WsServerFrame

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for WsServerFrame

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WsServerFrame

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WsServerFrame