Struct IoPubWelcome 

pub struct IoPubWelcome {
    pub subscription: String,
}

An iopub_welcome message on the iopub channel.

Per JEP 65, when IOPub is implemented as XPUB, this message is sent to clients upon subscription to indicate the kernel is ready to publish.

See JEP 65

Fields

subscription: String

The subscription topic that was received from the client. Typically an empty string for wildcard subscriptions.

Implementations

impl IoPubWelcome

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

Create a new JupyterMessage, assigning the parent for a IoPubWelcome 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::IoPubWelcome;

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

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

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

impl IoPubWelcome

pub fn new(subscription: String) -> Self

Trait Implementations

impl Clone for IoPubWelcome

fn clone(&self) -> IoPubWelcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IoPubWelcome

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

Formats the value using the given formatter.

impl Default for IoPubWelcome

fn default() -> IoPubWelcome

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IoPubWelcome

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<IoPubWelcome> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<IoPubWelcome> for JupyterMessageContent

fn from(content: IoPubWelcome) -> Self

Create a new JupyterMessageContent for a IoPubWelcome.

impl Serialize for IoPubWelcome

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

where __S: Serializer,

Serialize this value into the given Serde serializer.