Notebook

Struct Notebook 

Source
pub struct Notebook {
    pub cells: Vec<Cell>,
    pub metadata: NotebookMetadata,
    pub nbformat: u32,
    pub nbformat_minor: u32,
}
Expand description

A Jupyter notebook

Fields§

§cells: Vec<Cell>

Notebook cells

§metadata: NotebookMetadata

Notebook-level metadata

§nbformat: u32

nbformat version (major)

§nbformat_minor: u32

nbformat version (minor)

Implementations§

Source§

impl Notebook

Source

pub fn from_file(path: &Path) -> Result<Self, NotebookError>

Read a notebook from a file

Source

pub fn to_file(&self, path: &Path) -> Result<(), NotebookError>

Write a notebook to a file

Source

pub fn to_string(&self) -> Result<String, NotebookError>

Convert notebook to JSON string

Source

pub fn get_cell(&self, index: usize) -> Result<&Cell, NotebookError>

Get a cell by index

Source

pub fn get_cell_mut(&mut self, index: usize) -> Result<&mut Cell, NotebookError>

Get a mutable cell by index

Source

pub fn get_cells(&self, indices: &[usize]) -> Result<Vec<&Cell>, NotebookError>

Get multiple cells by indices

Source

pub fn cell_count(&self) -> usize

Count cells

Source

pub fn code_cell_count(&self) -> usize

Count code cells

Source

pub fn cell_timings(&self) -> Vec<CellTiming>

Get timing information for all cells

Returns a vector of CellTiming for all code cells that have timing metadata. Cells without timing metadata are skipped.

Source

pub fn timing_summary(&self) -> Option<TimingSummary>

Get timing summary for the notebook

Returns timing statistics (total, average, min, max) for all cells with timing data. Returns None if no cells have timing metadata.

Source

pub fn cells_with_timing_count(&self) -> usize

Count cells with timing metadata

Trait Implementations§

Source§

impl Clone for Notebook

Source§

fn clone(&self) -> Notebook

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Notebook

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Notebook

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl FromStr for Notebook

Source§

type Err = NotebookError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Serialize for Notebook

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,