Struct InputRequest

pub struct InputRequest {
    pub prompt: String,
    pub password: bool,
}

Request for input from the frontend.

This message is sent by the kernel when it needs to prompt the user for input. It’s typically used to implement functions like Python’s input() or R’s readline().

See https://jupyter-client.readthedocs.io/en/latest/messaging.html#messages-on-the-stdin-router-dealer-channel

Fields

prompt: String

password: bool

Implementations

impl InputRequest

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

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

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

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

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

Trait Implementations

impl Clone for InputRequest

fn clone(&self) -> InputRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputRequest

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

Formats the value using the given formatter.

impl Default for InputRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InputRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<InputRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<InputRequest> for JupyterMessageContent

fn from(content: InputRequest) -> Self

Create a new JupyterMessageContent for a InputRequest.

impl Serialize for InputRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.