Struct ShutdownRequest

pub struct ShutdownRequest {
    pub restart: bool,
}

Request to shut down the kernel.

Upon receiving this message, the kernel will send a reply and then shut itself down. If restart is True, the kernel will restart itself after shutting down.

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

Fields

restart: bool

Implementations

impl ShutdownRequest

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

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

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

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

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

Trait Implementations

impl Clone for ShutdownRequest

fn clone(&self) -> ShutdownRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownRequest

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

Formats the value using the given formatter.

impl Default for ShutdownRequest

fn default() -> ShutdownRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShutdownRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ShutdownRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<ShutdownRequest> for JupyterMessageContent

fn from(content: ShutdownRequest) -> JupyterMessageContent

Create a new JupyterMessageContent for a ShutdownRequest.

impl Serialize for ShutdownRequest

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.