Struct Notebook 

pub struct Notebook {
    pub cells: Vec<Cell>,
    pub metadata: NotebookMetadata,
    pub nbformat: u8,
    pub nbformat_minor: u8,
    pub sort_keys: bool,
}

A Jupyter notebook.

This is the central representation of a notebook in notebookx. It closely mirrors the structure of the Jupyter .ipynb format (nbformat version 4).

Example

use notebookx::{Notebook, Cell};

let mut notebook = Notebook::new();
notebook.cells.push(Cell::markdown("# Hello World"));
notebook.cells.push(Cell::code("print('Hello!')"));

Fields

cells: Vec<Cell>

The cells in this notebook.

metadata: NotebookMetadata

Notebook-level metadata.

nbformat: u8

Major version of the notebook format (always 4).

nbformat_minor: u8

Minor version of the notebook format.

sort_keys: bool

Whether to sort keys alphabetically when serializing to JSON. This is useful for VCS to produce consistent diffs.

Implementations

impl Notebook

pub fn clean(&self, options: &CleanOptions) -> Notebook

Clean the notebook according to the specified options.

This method returns a new notebook with the requested content removed. The original notebook is not modified.

Example

use notebookx::{Notebook, Cell, CleanOptions};

let mut notebook = Notebook::new();
notebook.cells.push(Cell::code("x = 1"));

let options = CleanOptions {
    remove_outputs: true,
    ..Default::default()
};

let cleaned = notebook.clean(&options);
assert_eq!(notebook.len(), cleaned.len()); // Original unchanged

impl Notebook

pub fn new() -> Self

Create a new empty notebook.

The notebook is created with nbformat version 4.5 (the current version with cell ID support) and empty metadata.

pub fn with_cells(cells: Vec<Cell>) -> Self

Create a notebook with the specified cells.

pub fn len(&self) -> usize

Get the number of cells in this notebook.

pub fn is_empty(&self) -> bool

Check if this notebook has no cells.

pub fn iter(&self) -> impl Iterator<Item = &Cell>

Iterate over the cells in this notebook.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Cell>

Iterate over the cells mutably.

pub fn code_cells(&self) -> impl Iterator<Item = &Cell>

Get only the code cells.

pub fn markdown_cells(&self) -> impl Iterator<Item = &Cell>

Get only the markdown cells.

Trait Implementations

impl Clone for Notebook

fn clone(&self) -> Notebook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Notebook

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

Formats the value using the given formatter.

impl Default for Notebook

fn default() -> Self

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a Notebook

type Item = &'a Cell

The type of the elements being iterated over.

type IntoIter = Iter<'a, Cell>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Notebook

type Item = Cell

The type of the elements being iterated over.

type IntoIter = IntoIter<Cell>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Notebook

fn eq(&self, other: &Notebook) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Notebook