Struct jupyter_client::Client

pub struct Client { /* private fields */ }

The main Client struct.

This handles communication between the user’s code, and the kernel itself. It abstracts the conversion of messages to and from the on-the-wire format.

Construction methods

• existing: looks for the latest connection file and tries to connect
• from_reader: reads connection details from a reader

Communication with kernels

• send_shell_command: send a shell command (like running a cell’s contents)
• send_control_command: send an important shell command
• iopub_subscribe: subscribe to published information from the kernel
• heartbeat_every: control the heartbeat and find out if the kernel dies
• heartbeat: send a heartbeat every second

Implementations

impl Client

pub fn existing() -> Result<Self>

Connect to the latest existing connection info file.

This searches the standard runtime path for the latest kernel config file by last-modified time. This is then loaded by using from_reader.

let client = Client::existing()?;

pub fn from_reader<R>(reader: R) -> Result<Self>where
    R: Read,

Connect to a kernel with a definition from a specific connection info file.

This takes an std::io::Read implementor (e.g. a std::fs::File).

// let file = File::open(...)?;
let client = Client::from_reader(file)?;

pub fn send_shell_command(&self, command: Command) -> Result<Response>

Send a shell command to the kernel.

pub fn send_control_command(&self, command: Command) -> Result<Response>

Send a control command to the kernel.

pub fn iopub_subscribe(&self) -> Result<Receiver<Response>>

Subscribe to IOPub messages.

pub fn heartbeat_every(&self, seconds: Duration) -> Result<Receiver<()>>

Subscribe to heartbeat messages on a given duration.

pub fn heartbeat(&self) -> Result<Receiver<()>>

Subscribe to heartbeat messages every second.