Struct CommMsg

pub struct CommMsg {
    pub comm_id: CommId,
    pub data: Map<String, Value>,
}

A comm_msg message on the iopub channel.

Comm messages are one-way communications to update comm state, used for synchronizing widget state, or simply requesting actions of a comm’s counterpart.

Essentially, each comm pair defines their own message specification implemented inside the data object.

There are no expected replies.

{
  "comm_id": "u-u-i-d",
  "data": {}
}

Fields

comm_id: CommId

data: Map<String, Value>

Implementations

impl CommMsg

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

Create a new JupyterMessage, assigning the parent for a CommMsg 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};
use jupyter_protocol::CommMsg;

let parent_message = JupyterMessage::new(jupyter_protocol::UnknownMessage {
  msg_type: "example".to_string(),
  content: serde_json::json!({ "key": "value" }),
}, None);

let child_message = CommMsg{
  ..Default::default()
}.as_child_of(&parent_message);

// Next you would send the `child_message` over the connection

Trait Implementations

impl Clone for CommMsg

fn clone(&self) -> CommMsg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommMsg

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

Formats the value using the given formatter.

impl Default for CommMsg

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommMsg

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CommMsg> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<CommMsg> for JupyterMessageContent

fn from(content: CommMsg) -> Self

Create a new JupyterMessageContent for a CommMsg.

impl Serialize for CommMsg

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

where __S: Serializer,

Serialize this value into the given Serde serializer.