Struct ClearOutput

pub struct ClearOutput {
    pub wait: bool,
}

Clear output of a single cell / output area.

Fields

wait: bool

Wait to clear the output until new output is available. Clears the existing output immediately before the new output is displayed. Useful for creating simple animations with minimal flickering.

Implementations

impl ClearOutput

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

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

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

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

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

Trait Implementations

impl Clone for ClearOutput

fn clone(&self) -> ClearOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClearOutput

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

Formats the value using the given formatter.

impl Default for ClearOutput

fn default() -> ClearOutput

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClearOutput

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

fn from(content: ClearOutput) -> Self

Create a new JupyterMessageContent for a ClearOutput.

impl Serialize for ClearOutput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.