Struct JupyterMessage

pub struct JupyterMessage {
    pub zmq_identities: Vec<Bytes>,
    pub header: Header,
    pub parent_header: Option<Header>,
    pub metadata: Value,
    pub content: JupyterMessageContent,
    pub buffers: Vec<Bytes>,
    pub channel: Option<Channel>,
}

A message in the Jupyter protocol format.

A Jupyter message consists of several parts:

• zmq_identities: ZeroMQ identities used for routing (not serialized)
• header: Metadata about the message
• parent_header: Header from parent message, if this is a response
• metadata: Additional metadata as JSON
• content: The main message content
• buffers: Binary buffers for messages that need them (not serialized)
• channel: The communication channel this message belongs to

Example

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

// Create a new execute_request message
let msg = JupyterMessage::new(
    ExecuteRequest {
        code: "print('Hello')".to_string(),
        silent: false,
        store_history: true,
        user_expressions: Default::default(),
        allow_stdin: true,
        stop_on_error: false,
    },
    None,
);

Messages can be created as responses to other messages by passing the parent:

let reply = JupyterMessage::new(
    ExecuteReply {
        status: ReplyStatus::Ok,
        execution_count: jupyter_protocol::ExecutionCount::new(1),
        ..Default::default()
    },
    Some(&parent),
);

Fields

zmq_identities: Vec<Bytes>

header: Header

parent_header: Option<Header>

metadata: Value

content: JupyterMessageContent

buffers: Vec<Bytes>

channel: Option<Channel>

Implementations

impl JupyterMessage

pub fn new( content: impl Into<JupyterMessageContent>, parent: Option<&JupyterMessage>, ) -> JupyterMessage

pub fn with_metadata(self, metadata: Value) -> Self

pub fn with_buffers(self, buffers: Vec<Bytes>) -> Self

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

pub fn with_zmq_identities(self, zmq_identities: Vec<Bytes>) -> Self

pub fn with_session(self, session: &str) -> Self

pub fn message_type(&self) -> &str

pub fn from_value(message: Value) -> Result<JupyterMessage, Error>

Trait Implementations

impl Clone for JupyterMessage

fn clone(&self) -> JupyterMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JupyterMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JupyterMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ClearOutput> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<CommClose> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<CommInfoReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<CommInfoRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<CommMsg> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<CommOpen> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<CompleteReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<CompleteRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<DebugReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<DebugRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<DisplayData> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<ErrorOutput> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<ExecuteInput> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<ExecuteReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<ExecuteRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<ExecuteResult> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<HistoryReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<HistoryRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<InputReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<InputRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<InspectReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<InspectRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<InterruptReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<InterruptRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<IsCompleteReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<IsCompleteRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<JupyterMessageContent> for JupyterMessage

fn from(content: JupyterMessageContent) -> Self

Converts to this type from the input type.

impl From<KernelInfoReply> for JupyterMessage

fn from(content: KernelInfoReply) -> Self

Converts to this type from the input type.

impl From<KernelInfoRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<ShutdownReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<ShutdownRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<Status> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<StreamContent> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<UnknownMessage> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<UpdateDisplayData> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl Serialize for JupyterMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.