Struct CompleteReply

pub struct CompleteReply {
    pub matches: Vec<String>,
    pub cursor_start: usize,
    pub cursor_end: usize,
    pub metadata: Map<String, Value>,
    pub status: ReplyStatus,
    pub error: Option<Box<ReplyError>>,
}

A reply containing code completion suggestions.

See https://jupyter-client.readthedocs.io/en/latest/messaging.html#completion

Fields

matches: Vec<String>

cursor_start: usize

cursor_end: usize

metadata: Map<String, Value>

status: ReplyStatus

error: Option<Box<ReplyError>>

Implementations

impl CompleteReply

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

Create a new JupyterMessage, assigning the parent for a CompleteReply message.

This method creates a new JupyterMessage with the right content, parent header, and zmq identities, making it suitable for sending over ZeroMQ.

Example

use jupyter_protocol::messaging::{JupyterMessage, JupyterMessageContent};
use jupyter_protocol::CompleteReply;

let parent_message = JupyterMessage::new(jupyter_protocol::UnknownMessage {
  msg_type: "example".to_string(),
  content: serde_json::json!({ "key": "value" }),
}, None);

let child_message = CompleteReply{
  ..Default::default()
}.as_child_of(&parent_message);

// Next you would send the `child_message` over the connection

Trait Implementations

impl Clone for CompleteReply

fn clone(&self) -> CompleteReply

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompleteReply

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

Formats the value using the given formatter.

impl Default for CompleteReply

fn default() -> CompleteReply

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CompleteReply

fn deserialize<__D>( __deserializer: __D, ) -> Result<CompleteReply, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CompleteReply> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<CompleteReply> for JupyterMessageContent

fn from(content: CompleteReply) -> JupyterMessageContent

Create a new JupyterMessageContent for a CompleteReply.

impl Serialize for CompleteReply

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

where __S: Serializer,

Serialize this value into the given Serde serializer.