Struct WebSocketMessage 

pub struct WebSocketMessage {
    pub event: String,
    pub data: Value,
}

Adapter-neutral WebSocket message used by gateways and adapters.

Fields

event: String

data: Value

Implementations

impl WebSocketMessage

pub fn new(event: impl Into<String>, data: impl Into<Value>) -> Self

pub fn event(&self) -> &str

pub fn data(&self) -> &Value

pub fn data_as<T>(&self) -> Result<T>

where T: DeserializeOwned,

pub fn data_field(&self, name: &str) -> Result<Option<Value>>

pub fn data_field_as<T>(&self, name: &str) -> Result<T>

where T: DeserializeOwned,

pub fn optional_data_field_as<T>(&self, name: &str) -> Result<Option<T>>

where T: DeserializeOwned,

pub fn data_field_string(&self, name: &str) -> Result<String>

pub fn optional_data_field_string(&self, name: &str) -> Result<Option<String>>

pub fn validated_data<T>(&self) -> Result<T>

where T: DeserializeOwned + Validate,

pub fn text(event: impl Into<String>, data: impl Into<String>) -> Self

pub fn json<T>(event: impl Into<String>, data: &T) -> Result<Self>

where T: Serialize,

Trait Implementations

impl Clone for WebSocketMessage

fn clone(&self) -> WebSocketMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebSocketMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<WebSocketMessage> for WebSocketExceptionResponse

fn from(message: WebSocketMessage) -> Self

Converts to this type from the input type.

impl IntoWebSocketReply for WebSocketMessage

fn into_websocket_reply(self) -> Option<WebSocketMessage>

impl PartialEq for WebSocketMessage

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WebSocketMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WebSocketMessage