Struct JupyterMessage

pub struct JupyterMessage {
    pub zmq_identities: Vec<Bytes>,
    pub header: Header,
    pub parent_header: Option<Header>,
    pub metadata: Value,
    pub content: JupyterMessageContent,
    pub buffers: Vec<Bytes>,
    pub channel: Option<Channel>,
}

Fields

zmq_identities: Vec<Bytes>

header: Header

parent_header: Option<Header>

metadata: Value

content: JupyterMessageContent

buffers: Vec<Bytes>

channel: Option<Channel>

Implementations

impl JupyterMessage

pub fn new( content: impl Into<JupyterMessageContent>, parent: Option<&JupyterMessage>, ) -> JupyterMessage

pub fn with_metadata(self, metadata: Value) -> Self

pub fn with_buffers(self, buffers: Vec<Bytes>) -> Self

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

pub fn with_zmq_identities(self, zmq_identities: Vec<Bytes>) -> Self

pub fn with_session(self, session: &str) -> Self

pub fn message_type(&self) -> &str

pub fn from_value(message: Value) -> Result<JupyterMessage, Error>

Trait Implementations

impl Clone for JupyterMessage

fn clone(&self) -> JupyterMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JupyterMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JupyterMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ClearOutput> for JupyterMessage

fn from(content: ClearOutput) -> Self

Create a new JupyterMessage for a ClearOutput.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<CommClose> for JupyterMessage

fn from(content: CommClose) -> Self

Create a new JupyterMessage for a CommClose.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<CommInfoReply> for JupyterMessage

fn from(content: CommInfoReply) -> Self

Create a new JupyterMessage for a CommInfoReply.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<CommInfoRequest> for JupyterMessage

fn from(content: CommInfoRequest) -> Self

Create a new JupyterMessage for a CommInfoRequest.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<CommMsg> for JupyterMessage

fn from(content: CommMsg) -> Self

Create a new JupyterMessage for a CommMsg.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<CommOpen> for JupyterMessage

fn from(content: CommOpen) -> Self

Create a new JupyterMessage for a CommOpen.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<CompleteReply> for JupyterMessage

fn from(content: CompleteReply) -> Self

Create a new JupyterMessage for a CompleteReply.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<CompleteRequest> for JupyterMessage

fn from(content: CompleteRequest) -> Self

Create a new JupyterMessage for a CompleteRequest.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<DebugReply> for JupyterMessage

fn from(content: DebugReply) -> Self

Create a new JupyterMessage for a DebugReply.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<DebugRequest> for JupyterMessage

fn from(content: DebugRequest) -> Self

Create a new JupyterMessage for a DebugRequest.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<DisplayData> for JupyterMessage

fn from(content: DisplayData) -> Self

Create a new JupyterMessage for a DisplayData.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<ErrorOutput> for JupyterMessage

fn from(content: ErrorOutput) -> Self

Create a new JupyterMessage for a ErrorOutput.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<ExecuteInput> for JupyterMessage

fn from(content: ExecuteInput) -> Self

Create a new JupyterMessage for a ExecuteInput.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<ExecuteReply> for JupyterMessage

fn from(content: ExecuteReply) -> Self

Create a new JupyterMessage for a ExecuteReply.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<ExecuteRequest> for JupyterMessage

fn from(content: ExecuteRequest) -> Self

Create a new JupyterMessage for a ExecuteRequest.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<ExecuteResult> for JupyterMessage

fn from(content: ExecuteResult) -> Self

Create a new JupyterMessage for a ExecuteResult.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<HistoryReply> for JupyterMessage

fn from(content: HistoryReply) -> Self

Create a new JupyterMessage for a HistoryReply.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<HistoryRequest> for JupyterMessage

fn from(content: HistoryRequest) -> Self

Create a new JupyterMessage for a HistoryRequest.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<InputReply> for JupyterMessage

fn from(content: InputReply) -> Self

Create a new JupyterMessage for a InputReply.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<InputRequest> for JupyterMessage

fn from(content: InputRequest) -> Self

Create a new JupyterMessage for a InputRequest.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<InspectReply> for JupyterMessage

fn from(content: InspectReply) -> Self

Create a new JupyterMessage for a InspectReply.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<InspectRequest> for JupyterMessage

fn from(content: InspectRequest) -> Self

Create a new JupyterMessage for a InspectRequest.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<InterruptReply> for JupyterMessage

fn from(content: InterruptReply) -> Self

Create a new JupyterMessage for a InterruptReply.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<InterruptRequest> for JupyterMessage

fn from(content: InterruptRequest) -> Self

Create a new JupyterMessage for a InterruptRequest.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<IsCompleteReply> for JupyterMessage

fn from(content: IsCompleteReply) -> Self

Create a new JupyterMessage for a IsCompleteReply.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<IsCompleteRequest> for JupyterMessage

fn from(content: IsCompleteRequest) -> Self

Create a new JupyterMessage for a IsCompleteRequest.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<JupyterMessageContent> for JupyterMessage

fn from(content: JupyterMessageContent) -> Self

Converts to this type from the input type.

impl From<KernelInfoReply> for JupyterMessage

fn from(content: KernelInfoReply) -> Self

Converts to this type from the input type.

impl From<KernelInfoRequest> for JupyterMessage

fn from(content: KernelInfoRequest) -> Self

Create a new JupyterMessage for a KernelInfoRequest.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<ShutdownReply> for JupyterMessage

fn from(content: ShutdownReply) -> Self

Create a new JupyterMessage for a ShutdownReply.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<ShutdownRequest> for JupyterMessage

fn from(content: ShutdownRequest) -> Self

Create a new JupyterMessage for a ShutdownRequest.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<Status> for JupyterMessage

fn from(content: Status) -> Self

Create a new JupyterMessage for a Status.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<StreamContent> for JupyterMessage

fn from(content: StreamContent) -> Self

Create a new JupyterMessage for a StreamContent.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<UnknownMessage> for JupyterMessage

fn from(content: UnknownMessage) -> Self

Create a new JupyterMessage for a UnknownMessage.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl From<UpdateDisplayData> for JupyterMessage

fn from(content: UpdateDisplayData) -> Self

Create a new JupyterMessage for a UpdateDisplayData.

⚠️ If you use this method, you must set the zmq identities yourself. If you have a message that “caused” your message to be sent, use that message with as_child_of instead.

impl Serialize for JupyterMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.