Struct StreamContent

pub struct StreamContent {
    pub name: Stdio,
    pub text: String,
}

A 'stream' message on the 'iopub' channel.

See Streams.

Example

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

use jupyter_protocol::messaging::{ExecuteRequest};
// From the UI

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

As a side effect of execution, the kernel can send 'stream' messages to the UI/client. These are from using print(), console.log(), or similar. Anything on STDOUT or STDERR.

use jupyter_protocol::messaging::{StreamContent, Stdio};
let execute_request = shell.read().await?;

let message = StreamContent {
  name: Stdio::Stdout,
  text: "Hello, World".to_string()
}.as_child_of(execute_request);
iopub.send(message).await?;

Fields

name: Stdio

text: String

Implementations

impl StreamContent

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

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

let message = connection.recv().await?;

let child_message = StreamContent{
  // ...
}.as_child_of(&message);

connection.send(child_message).await?;

impl StreamContent

pub fn stdout(text: &str) -> Self

pub fn stderr(text: &str) -> Self

Trait Implementations

impl Clone for StreamContent

fn clone(&self) -> StreamContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StreamContent> for JupyterMessage

fn from(content: StreamContent) -> Self

Create a new JupyterMessage for a StreamContent.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<StreamContent> for JupyterMessageContent

fn from(content: StreamContent) -> Self

Create a new JupyterMessageContent for a StreamContent.

impl Serialize for StreamContent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.