jupyter-types 0.0.2

Shared types for jupyter kernel
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

use serde_json::Value;

/// A executed result that can be render in jupyter notebook.
pub trait Executed: Send {
    /// The mime type of the result.
    fn mime_type(&self) -> String;
    /// Convert the result to json.
    fn as_json(&self, context: &JupyterContext) -> Value;
}

/// The running context of the Jupyter notebook
#[derive(Copy, Debug, Clone)]
pub struct JupyterContext {
    /// The theme of the Jupyter notebook
    pub theme: JupyterTheme,
    /// Limit the number of output lists to prevent the front end from getting stuck
    pub record_limit: usize,
    /// Limit the number of output objects to prevent the front end from getting stuck
    pub object_limit: usize,
    /// Limit the depth of output objects to prevent the front end from getting stuck
    pub object_depth: usize,
}

/// The theme of the Jupyter notebook
#[derive(Copy, Debug, Clone)]
pub enum JupyterTheme {
    /// Light theme
    Light,
    /// Dark theme
    Dark,
}

impl Default for JupyterContext {
    fn default() -> Self {
        Self { theme: JupyterTheme::Light, record_limit: 64, object_limit: 64, object_depth: 64 }
    }
}