Struct ExecuteReply

pub struct ExecuteReply {
    pub status: ReplyStatus,
    pub execution_count: ExecutionCount,
    pub payload: Vec<Payload>,
    pub user_expressions: Option<HashMap<String, String>>,
    pub error: Option<Box<ReplyError>>,
}

A reply to an execute request. This is not the output of execution, as this is the reply over the shell socket. Any number of outputs can be emitted as StreamContent, DisplayData, UpdateDisplayData, ExecuteResult, and ErrorOutput. This message is used to communicate the status of the execution request, the execution count, and any user expressions that were requested.

See https://jupyter-client.readthedocs.io/en/latest/messaging.html#execution-results

Fields

status: ReplyStatus

execution_count: ExecutionCount

payload: Vec<Payload>

user_expressions: Option<HashMap<String, String>>

error: Option<Box<ReplyError>>

Implementations

impl ExecuteReply

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

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

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

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

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

Trait Implementations

impl Clone for ExecuteReply

fn clone(&self) -> ExecuteReply

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteReply

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

Formats the value using the given formatter.

impl Default for ExecuteReply

fn default() -> ExecuteReply

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExecuteReply

fn deserialize<__D>( __deserializer: __D, ) -> Result<ExecuteReply, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ExecuteReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<ExecuteReply> for JupyterMessageContent

fn from(content: ExecuteReply) -> JupyterMessageContent

Create a new JupyterMessageContent for a ExecuteReply.

impl Serialize for ExecuteReply

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

where __S: Serializer,

Serialize this value into the given Serde serializer.