Struct NotebookEngine 

pub struct NotebookEngine { /* private fields */ }

Core notebook execution engine

Maintains REPL state across cell executions, enabling variables and state to persist between cells (Jupyter-like behavior).

Examples

use ruchy::notebook::engine::NotebookEngine;

let mut engine = NotebookEngine::new().unwrap();
let result = engine.execute_cell("let x = 42").unwrap();
assert_eq!(result, "()");

let result = engine.execute_cell("x + 8").unwrap();
assert_eq!(result, "50");

Implementations

impl NotebookEngine

pub fn new() -> Result<Self>

Create a new notebook engine

Errors

Returns error if REPL initialization fails

Examples

use ruchy::notebook::engine::NotebookEngine;

let engine = NotebookEngine::new();
assert!(engine.is_ok());

pub fn execute_cell(&mut self, code: &str) -> Result<String>

Execute a cell and return the formatted output

State persists across cell executions (variables remain in scope).

Errors

Returns error if cell execution fails (parse error, runtime error, etc.)

Examples

use ruchy::notebook::engine::NotebookEngine;

let mut engine = NotebookEngine::new().unwrap();
let result = engine.execute_cell("1 + 1").unwrap();
assert_eq!(result, "2");

pub fn execute_cell_detailed(&mut self, code: &str) -> CellExecutionResult

Execute a cell and return detailed execution results

Returns a CellExecutionResult with output, stdout, stderr, and timing.

Examples

use ruchy::notebook::engine::NotebookEngine;

let mut engine = NotebookEngine::new().unwrap();
let result = engine.execute_cell_detailed("1 + 1");

assert!(result.is_success());
assert_eq!(result.output(), "2");
assert!(result.duration_ms() < 100);

pub fn create_checkpoint(&self, name: String) -> Checkpoint

Create a checkpoint of the current notebook state

Examples

use ruchy::notebook::engine::NotebookEngine;

let mut engine = NotebookEngine::new().unwrap();
engine.execute_cell("let x = 42").unwrap();

let checkpoint = engine.create_checkpoint("before_change".to_string());
assert_eq!(checkpoint.name(), "before_change");

pub fn restore_checkpoint(&mut self, checkpoint: &Checkpoint)

Restore notebook state from a checkpoint

Examples

use ruchy::notebook::engine::NotebookEngine;

let mut engine = NotebookEngine::new().unwrap();
engine.execute_cell("let x = 10").unwrap();
let checkpoint = engine.create_checkpoint("save".to_string());

engine.execute_cell("x = 99").unwrap();
engine.restore_checkpoint(&checkpoint);

let result = engine.execute_cell("x").unwrap();
assert_eq!(result, "10");

pub fn execute_transaction(&mut self, code: &str) -> TransactionResult<String>

Execute code transactionally with automatic rollback on error

If execution fails, state is automatically rolled back to before the transaction.

Examples

use ruchy::notebook::engine::NotebookEngine;

let mut engine = NotebookEngine::new().unwrap();
engine.execute_cell("let x = 10").unwrap();

// This will fail and rollback
let result = engine.execute_transaction("x = invalid_syntax");
assert!(result.is_rolled_back());

// Original state preserved
let value = engine.execute_cell("x").unwrap();
assert_eq!(value, "10");

Trait Implementations

impl Debug for NotebookEngine

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

Formats the value using the given formatter.