Struct DisplayData

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

A display_data message on the iopub channel.

See Display Data.

Example

The UI/client sends an execute_request message to the kernel.

use jupyter_protocol::{ExecuteRequest, JupyterMessage};

let execute_request: JupyterMessage = ExecuteRequest {
    code: "print('Hello, World!')".to_string(),
    silent: false,
    store_history: true,
    user_expressions: None,
    allow_stdin: false,
    stop_on_error: true,
}.into();

// As a side effect of execution, the kernel can send `display_data` messages to the UI/client.

use jupyter_protocol::{DisplayData, Media, MediaType};

let raw = r#"{
    "text/plain": "Hello, world!",
    "text/html": "<h1>Hello, world!</h1>"
}"#;

let bundle: Media = serde_json::from_str(raw).unwrap();

let message = DisplayData {
   data: bundle,
   metadata: Default::default(),
   transient: None,
}.as_child_of(&execute_request);
// Send back the response over the iopub connection

Fields

data: Media

metadata: Map<String, Value>

transient: Option<Transient>

Implementations

impl DisplayData

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

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

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

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

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

impl DisplayData

pub fn new(data: Media) -> Self

Trait Implementations

impl Clone for DisplayData

fn clone(&self) -> DisplayData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayData

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

Formats the value using the given formatter.

impl Default for DisplayData

fn default() -> DisplayData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DisplayData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DisplayData> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<DisplayData> for JupyterMessageContent

fn from(content: DisplayData) -> Self

Create a new JupyterMessageContent for a DisplayData.

impl From<MediaType> for DisplayData

fn from(content: MediaType) -> Self

Converts to this type from the input type.

impl From<Vec<MediaType>> for DisplayData

fn from(content: Vec<MediaType>) -> Self

Converts to this type from the input type.

impl Serialize for DisplayData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.