Struct ShutdownReply

pub struct ShutdownReply {
    pub restart: bool,
    pub status: ReplyStatus,
    pub error: Option<Box<ReplyError>>,
}

Reply to a shutdown request.

This message is sent by the kernel in response to a ShutdownRequest. It confirms that the kernel is shutting down.

See https://jupyter-client.readthedocs.io/en/latest/messaging.html#kernel-shutdown

Fields

restart: bool

status: ReplyStatus

error: Option<Box<ReplyError>>

Implementations

impl ShutdownReply

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

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

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

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

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

Trait Implementations

impl Clone for ShutdownReply

fn clone(&self) -> ShutdownReply

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownReply

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

Formats the value using the given formatter.

impl Default for ShutdownReply

fn default() -> ShutdownReply

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShutdownReply

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ShutdownReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<ShutdownReply> for JupyterMessageContent

fn from(content: ShutdownReply) -> JupyterMessageContent

Create a new JupyterMessageContent for a ShutdownReply.

impl Serialize for ShutdownReply

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.