Enum HistoryRequest

pub enum HistoryRequest {
    Range {
        session: Option<i32>,
        start: i32,
        stop: i32,
        output: bool,
        raw: bool,
    },
    Tail {
        n: i32,
        output: bool,
        raw: bool,
    },
    Search {
        pattern: String,
        unique: bool,
        output: bool,
        raw: bool,
    },
}

Variants

Range

Fields

session: Option<i32>

start: i32

stop: i32

output: bool

raw: bool

Tail

Fields

n: i32

output: bool

raw: bool

Search

Fields

pattern: String

unique: bool

output: bool

raw: bool

Implementations

impl HistoryRequest

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

Create a new JupyterMessage, assigning the parent for a HistoryRequest 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::HistoryRequest;

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

let child_message = HistoryRequest::Range {
    session: None,
    start: 0,
    stop: 10,
    output: false,
    raw: false,
}.as_child_of(&parent_message);

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

Trait Implementations

impl Clone for HistoryRequest

fn clone(&self) -> HistoryRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HistoryRequest

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

Formats the value using the given formatter.

impl Default for HistoryRequest

fn default() -> HistoryRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HistoryRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<HistoryRequest> for JupyterMessage

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<HistoryRequest> for JupyterMessageContent

fn from(content: HistoryRequest) -> JupyterMessageContent

Create a new JupyterMessageContent for a HistoryRequest.

impl Serialize for HistoryRequest

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.