šDeprecated since 0.8.0: This crate is deprecated. Use jupyter-protocol instead.
ModulesĀ§
- Defines structures and functions for Jupyter kernel connection information.
- Provides types and utilities for working with rich media content in Jupyter messages.
- Defines the core message types and structures for the Jupyter messaging protocol.
StructsĀ§
- Clear output of a single cell / output area.
- A
comm_close
message on theiopub
channel. - A
comm_msg
message on theiopub
channel. - A
comm_open
message on theiopub
channel. - A reply containing code completion suggestions.
- A request for code completion suggestions.
- Represents the runtime connection information for a Jupyter kernel.
- A
display_data
message on theiopub
channel. - A reply to an execute request. This is not the output of execution, as this is the reply over the
shell
socket. Any number of outputs can be emitted asStreamContent
,DisplayData
,UpdateDisplayData
,ExecuteResult
, andErrorOutput
. This message is used to communicate the status of the execution request, the execution count, and any user expressions that were requested. - A request for code execution.
- Represents a monotonically increasing counter for tracking the number of code executions in a Jupyter session. This count is maintained across all executions, including those in notebook cells and via terminal
execute_request
s. - Represents a Jupyter message header.
- A reply containing execution history.
- Reply to an input request.
- Request for input from the frontend.
- A
inspect_request
message on theshell
channel. - Reply to an interrupt request.
- Request to interrupt the kernel.
- A request to check if the code is complete and ready for execution.
- Represents the contents of a Jupyter JSON kernelspec file.
- A message in the Jupyter protocol format.
- A reply containing information about the kernel.
- A request for information about the kernel.
- A
Media
is a collection of data associated with different Media types. It allows for the representation of rich content that can be displayed in multiple formats. These are found in thedata
field of aDisplayData
andExecuteResult
messages/output types. - Reply to a shutdown request.
- Request to shut down the kernel.
- A message indicating the current status of the kernel.
- A
stream
message on theiopub
channel. These are also known as āstdoutā and āstderrā. - Optional metadata for a display data to allow for updating an output.
- Unknown message types are a workaround for generically unknown messages.
EnumsĀ§
- Represents the different channels in the Jupyter messaging protocol.
- An enumeration representing various Media types, otherwise known as MIME (Multipurpose Internet Mail Extensions) types. These types are used to indicate the nature of the data in a rich content message such as
DisplayData
,UpdateDisplayData
, andExecuteResult
. - Payloads are a way to trigger frontend actions from the kernel. They are stated as deprecated, however they are in regular use via
?
in IPython - All reply messages have a
status
field. - Represents the transport protocol used for Jupyter kernel communication.