Struct UnknownMessage

pub struct UnknownMessage {
    pub msg_type: String,
    pub content: Value,
}

Unknown message types are a workaround for generically unknown messages.

use jupyter_protocol::messaging::{JupyterMessage, JupyterMessageContent, UnknownMessage};
use serde_json::json;

let msg = UnknownMessage {
    msg_type: "example_request".to_string(),
    content: json!({ "key": "value" }),
};

let reply_msg = msg.reply(json!({ "status": "ok" }));

Fields

msg_type: String

content: Value

Implementations

impl UnknownMessage

pub fn as_child_of(&self, parent: &JupyterMessage) -> JupyterMessage

Create a new JupyterMessage, assigning the parent for a UnknownMessage message.

This method creates a new JupyterMessage with the right content, parent header, and zmq identities, making it suitable for sending over ZeroMQ.

Example

use jupyter_protocol::messaging::{JupyterMessage, JupyterMessageContent};

let message = connection.recv().await?;

let child_message = UnknownMessage{
  // ...
}.as_child_of(&message);

connection.send(child_message).await?;

impl UnknownMessage

pub fn reply(&self, content: Value) -> JupyterMessageContent

Trait Implementations

impl Clone for UnknownMessage

fn clone(&self) -> UnknownMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnknownMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UnknownMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<UnknownMessage> for JupyterMessage

fn from(content: UnknownMessage) -> Self

Create a new JupyterMessage for a UnknownMessage.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<UnknownMessage> for JupyterMessageContent

fn from(content: UnknownMessage) -> Self

Create a new JupyterMessageContent for a UnknownMessage.

impl Serialize for UnknownMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.