Struct CommOpen

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

A 'comm_open' message on the 'iopub' channel.

See Comm Open.

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

Opening a Comm produces a comm_open message, to be sent to the other side:

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

Every Comm has an ID and a target name. The code handling the message on the receiving side is responsible for maintaining a mapping of target_name keys to constructors. After a comm_open message has been sent, there should be a corresponding Comm instance on both sides. The data key is always a object with any extra JSON information used in initialization of the comm.

If the target_name key is not found on the receiving side, then it should immediately reply with a comm_close message to avoid an inconsistent state.

Fields

comm_id: CommId

target_name: String

data: Map<String, Value>

Implementations

impl CommOpen

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

Create a new JupyterMessage, assigning the parent for a CommOpen 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 = CommOpen{
  // ...
}.as_child_of(&message);

connection.send(child_message).await?;

Trait Implementations

impl Clone for CommOpen

fn clone(&self) -> CommOpen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommOpen

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommOpen

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CommOpen> for JupyterMessage

fn from(content: CommOpen) -> Self

Create a new JupyterMessage for a CommOpen.

⚠️ 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<CommOpen> for JupyterMessageContent

fn from(content: CommOpen) -> Self

Create a new JupyterMessageContent for a CommOpen.

impl Serialize for CommOpen

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

where __S: Serializer,

Serialize this value into the given Serde serializer.