Struct ExecuteResult

pub struct ExecuteResult {
    pub execution_count: ExecutionCount,
    pub data: Media,
    pub metadata: Map<String, Value>,
    pub transient: Option<Transient>,
}

An execute_result message on the iopub channel. See Execute Result.

The is the “result”, in the REPL sense from execution. As an example, the following Python code:

>>> 3 + 4
7

would have an execute_result message with the following content:

{
    "execution_count": 1,
    "data": {
        "text/plain": "7"
    },
    "metadata": {},
    "transient": {}
}

Fields

execution_count: ExecutionCount

data: Media

metadata: Map<String, Value>

transient: Option<Transient>

Implementations

impl ExecuteResult

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

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

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

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

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

impl ExecuteResult

pub fn new(execution_count: ExecutionCount, data: Media) -> ExecuteResult

Trait Implementations

impl Clone for ExecuteResult

fn clone(&self) -> ExecuteResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteResult

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

Formats the value using the given formatter.

impl Default for ExecuteResult

fn default() -> ExecuteResult

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExecuteResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<(ExecutionCount, MediaType)> for ExecuteResult

fn from(_: (ExecutionCount, MediaType)) -> ExecuteResult

Converts to this type from the input type.

impl From<(ExecutionCount, Vec<MediaType>)> for ExecuteResult

fn from(_: (ExecutionCount, Vec<MediaType>)) -> ExecuteResult

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<ExecuteResult> for JupyterMessageContent

fn from(content: ExecuteResult) -> JupyterMessageContent

Create a new JupyterMessageContent for a ExecuteResult.

impl Serialize for ExecuteResult

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.