Struct wamp_core::messages::goodbye::Goodbye

pub struct Goodbye {
    pub details: Value,
    pub reason: String,
}

Goodbye - wamp-proto

represenets an goodbye message in wamp protocol.

Examples

use wamp_core::messages::Goodbye;
use wamp_core::goodbye;
use serde_json::json;

let goodbye_message = Goodbye {
    reason: "wamp.close.system_shutdown".to_string(),
    details: json!({})
};

Serializer

Implements serde Serialize trait for Goodbye

use wamp_core::messages::Goodbye;
use serde_json::{json, to_string};

// Create an goodbye message
let goodbye = Goodbye {
    details: json!({"message": "The host is shutting down now."}),
    reason: "wamp.close.system_shutdown".to_string()
};

// Establish raw json data string
let data = r#"[6,{"message":"The host is shutting down now."},"wamp.close.system_shutdown"]"#;

// Here we convert it from an `Goodbye` frame, to a string representation.
let goodbye = to_string(&goodbye).unwrap();

// Confirm that our Goodbye frame strings are equal to eachother
assert_eq!(goodbye, data);

Deserializer

Implements serde Deserialize trait for Goodbye

use wamp_core::messages::Goodbye;
use serde_json::from_str;

// Here is our raw json data string
let data = r#"[6,{"message": "The host is shutting down now."},"wamp.close.system_shutdown"]"#;

// Here we convert it to an `goodbye` frame
let goodbye = from_str::<Goodbye>(data).unwrap();

// Confirm that our error type deserialized
assert_eq!(goodbye.reason, "wamp.close.system_shutdown");

Fields

details: Value

reason: String

Trait Implementations

impl Clone for Goodbye

fn clone(&self) -> Goodbye

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Goodbye

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Goodbye

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Goodbye> for Messages

fn from(v: Goodbye) -> Messages

Converts to this type from the input type.

impl From<Messages> for Goodbye

fn from(v: Messages) -> Goodbye

Converts to this type from the input type.

impl PartialEq for Goodbye

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Goodbye

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Goodbye> for Message

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Goodbye) -> Result<Message, Self::Error>

Performs the conversion.

impl WampMessage for Goodbye

const ID: u64 = 6u64

fn direction(role: Roles) -> &'static MessageDirection

Direction method

impl Eq for Goodbye

impl StructuralEq for Goodbye

impl StructuralPartialEq for Goodbye