Struct InspectRequest

pub struct InspectRequest {
    pub code: String,
    pub cursor_pos: usize,
    pub detail_level: Option<usize>,
}

A inspect_request message on the shell channel.

Code can be inspected to show useful information to the user. It is up to the Kernel to decide what information should be displayed, and its formatting.

Fields

code: String

The code context in which introspection is requested this may be up to an entire multiline cell.

cursor_pos: usize

The cursor position within ‘code’ (in unicode characters) where inspection is requested

detail_level: Option<usize>

The level of detail desired. In IPython, the default (0) is equivalent to typing ‘x?’ at the prompt, 1 is equivalent to ‘x??’. The difference is up to kernels, but in IPython level 1 includes the source code if available.

Implementations

impl InspectRequest

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

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

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

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

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

Trait Implementations

impl Clone for InspectRequest

fn clone(&self) -> InspectRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InspectRequest

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

Formats the value using the given formatter.

impl Default for InspectRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InspectRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<InspectRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<InspectRequest> for JupyterMessageContent

fn from(content: InspectRequest) -> Self

Create a new JupyterMessageContent for a InspectRequest.

impl Serialize for InspectRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.