Struct ConnectionInfo

pub struct ConnectionInfo {
    pub ip: String,
    pub transport: Transport,
    pub shell_port: u16,
    pub iopub_port: u16,
    pub stdin_port: u16,
    pub control_port: u16,
    pub hb_port: u16,
    pub key: String,
    pub signature_scheme: String,
    pub kernel_name: Option<String>,
}

Represents the runtime connection information for a Jupyter kernel.

This struct contains all the necessary information for a Jupyter client to connect to a kernel, including ports, transport protocol, and authentication details.

Fields

• ip - The IP address of the kernel.
• transport - The transport protocol (TCP or IPC).
• shell_port - The port number for the shell channel.
• iopub_port - The port number for the IOPub channel.
• stdin_port - The port number for the stdin channel.
• control_port - The port number for the control channel.
• hb_port - The port number for the heartbeat channel.
• key - The authentication key.
• signature_scheme - The signature scheme used for message authentication.
• kernel_name - An optional name for the kernel.

Example

use jupyter_protocol::connection_info::{ConnectionInfo, Transport};

let info = ConnectionInfo {
    ip: "127.0.0.1".to_string(),
    transport: Transport::TCP,
    shell_port: 6767,
    iopub_port: 6768,
    stdin_port: 6790,
    control_port: 6791,
    hb_port: 6792,
    key: "secret_key".to_string(),
    signature_scheme: "hmac-sha256".to_string(),
    kernel_name: Some("python3".to_string()),
};

assert_eq!(info.shell_url(), "tcp://127.0.0.1:6767");

Fields

ip: String

transport: Transport

shell_port: u16

iopub_port: u16

stdin_port: u16

control_port: u16

hb_port: u16

key: String

signature_scheme: String

kernel_name: Option<String>

Implementations

impl ConnectionInfo

Provides methods to generate formatted URLs for various Jupyter communication channels.

pub fn iopub_url(&self) -> String

Formats the URL for the IOPub channel.

Returns

A String containing the formatted URL for the IOPub channel. format the iopub url for a ZeroMQ connection

pub fn shell_url(&self) -> String

format the shell url for a ZeroMQ connection Formats the URL for the shell channel.

Returns

A String containing the formatted URL for the shell channel.

pub fn stdin_url(&self) -> String

format the stdin url for a ZeroMQ connection Formats the URL for the stdin channel.

Returns

A String containing the formatted URL for the stdin channel.

pub fn control_url(&self) -> String

format the control url for a ZeroMQ connection Formats the URL for the control channel.

Returns

A String containing the formatted URL for the control channel.

pub fn hb_url(&self) -> String

format the heartbeat url for a ZeroMQ connection Formats the URL for the heartbeat channel.

Returns

A String containing the formatted URL for the heartbeat channel.

Trait Implementations

impl Clone for ConnectionInfo

fn clone(&self) -> ConnectionInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectionInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConnectionInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ConnectionInfo

fn eq(&self, other: &ConnectionInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ConnectionInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConnectionInfo