Struct JupyterKernelspec

pub struct JupyterKernelspec {
    pub argv: Vec<String>,
    pub display_name: String,
    pub language: String,
    pub metadata: Option<HashMap<String, Value>>,
    pub interrupt_mode: Option<String>,
    pub env: Option<HashMap<String, String>>,
}

Represents the contents of a Jupyter JSON kernelspec file.

A kernelspec file defines the properties and launch parameters for a Jupyter kernel. This struct is used to serialize and deserialize kernelspec data.

Examples

use jupyter_protocol::JupyterKernelspec;
use std::collections::HashMap;

let kernelspec = JupyterKernelspec {
    argv: vec![
        "python3".to_string(),
        "-m".to_string(),
        "ipykernel_launcher".to_string(),
        "-f".to_string(),
        "{connection_file}".to_string()
    ],
    display_name: "Python 3".to_string(),
    language: "python".to_string(),
    metadata: None,
    interrupt_mode: Some("signal".to_string()),
    env: Some(HashMap::new()),
};

Fields

argv: Vec<String>

The command line arguments used to launch the kernel.

This vector must contain {connection_file} as a placeholder, which will be replaced by the actual connection file path when the client launches the kernel.

display_name: String

The human-readable name for the kernel.

This name is typically displayed in the Jupyter interface when selecting a kernel.

language: String

The programming language supported by the kernel.

This should be a string identifier for the language, such as “python”, “r”, or “julia”.

metadata: Option<HashMap<String, Value>>

Additional metadata associated with the kernel.

This field can contain arbitrary key-value pairs for kernel-specific information. The values can be of any JSON-compatible type.

interrupt_mode: Option<String>

Specifies how the kernel should be interrupted.

Common values are “signal” (use SIGINT) or “message” (use kernel protocol). If not specified, the client will use a default interrupt method.

env: Option<HashMap<String, String>>

Environment variables to set for the kernel process.

These key-value pairs will be added to the environment when launching the kernel.

Trait Implementations

impl Clone for JupyterKernelspec

fn clone(&self) -> JupyterKernelspec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JupyterKernelspec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JupyterKernelspec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for JupyterKernelspec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.