Struct SourceEditor 

pub struct SourceEditor { /* private fields */ }

Editor for modifying .rs notebook source files.

Holds an exclusive file lock for the duration of the edit session to prevent concurrent modifications.

Implementations

impl SourceEditor

pub fn load(path: &Path) -> Result<Self>

Load a source file for editing.

Acquires an exclusive advisory lock on the file to prevent concurrent modifications from other processes.

pub fn insert_cell(&mut self, after_cell_id: Option<&str>) -> Result<String>

Insert a new cell after the specified cell.

If after_cell_id is None, inserts at the end of the file. Returns the name of the newly created cell.

pub fn delete_cell(&mut self, cell_name: &str) -> Result<String>

Delete a cell by name.

Returns the name of the deleted cell.

pub fn duplicate_cell(&mut self, cell_name: &str) -> Result<String>

Duplicate a cell by name.

Creates a copy of the cell with a unique name (e.g., cell_name_copy). The new cell is inserted immediately after the original. Returns the name of the new cell.

pub fn move_cell( &mut self, cell_name: &str, direction: MoveDirection, ) -> Result<()>

Move a cell up or down by swapping with its neighbor.

Returns Ok(()) on success.

pub fn rename_cell( &mut self, cell_name: &str, new_display_name: &str, ) -> Result<()>

Rename a cell’s display name by updating its doc comment.

Updates or adds a # Display Name heading to the cell’s doc comment.

pub fn insert_markdown_cell( &mut self, content: &str, after_line: Option<usize>, ) -> Result<()>

Insert a markdown cell at a specific line position.

If after_line is None, inserts at the beginning of the file. Content should be plain markdown text (without /// prefix).

pub fn insert_raw_code( &mut self, content: &str, after_line: Option<usize>, ) -> Result<()>

Insert raw Rust code (for definition cells, imports, etc.) without any formatting. This is a generic method for inserting plain Rust code without comment prefix or attributes.

pub fn edit_markdown_cell( &mut self, start_line: usize, end_line: usize, new_content: &str, is_module_doc: bool, ) -> Result<()>

Edit an existing markdown cell by line range.

Replaces the comment block at the given line range with new content. If is_module_doc is true, uses //! syntax; otherwise uses ///.

pub fn edit_raw_code( &mut self, start_line: usize, end_line: usize, new_content: &str, ) -> Result<()>

Edit raw Rust code by line range (for definition cells, etc.) without any formatting. Replaces the code block at the given line range with new content as-is.

pub fn delete_markdown_cell( &mut self, start_line: usize, end_line: usize, ) -> Result<()>

Delete a markdown cell by line range.

pub fn move_markdown_cell( &mut self, start_line: usize, end_line: usize, direction: MoveDirection, ) -> Result<()>

Move a markdown cell up or down.

Swaps the markdown block with the adjacent one.

pub fn save(&self) -> Result<()>

Save changes to the file.

The exclusive lock is maintained until SourceEditor is dropped, ensuring no other process can modify the file between save and drop.

pub fn get_cell_source(&self, cell_name: &str) -> Result<String>

Get the source code of a cell (including doc comments and attributes).

Used for undo operations to capture cell content before deletion.

pub fn get_previous_cell_name(&self, cell_name: &str) -> Result<Option<String>>

Get the name of the cell that appears before the specified cell.

Returns None if the cell is the first one. Used for undo operations to track position for restoration.

pub fn restore_cell( &mut self, source: &str, after_cell_name: Option<&str>, ) -> Result<()>

Restore a cell with specific source code after a specific cell.

If after_cell_name is None, inserts at the beginning (before all cells). Used for undo delete operations.

pub fn find_cell_span( &self, file: &SynFile, cell_name: &str, ) -> Result<(usize, usize)>

Find the span of a cell (start line to end line, 1-indexed). Includes doc comments and attributes above the function.

pub fn find_function_span( &self, file: &SynFile, cell_name: &str, ) -> Result<(usize, usize)>

Find just the function span (NOT doc comments) for editing.

pub fn extract_doc_comments(&self, cell_name: &str) -> Result<Vec<String>>

Extract existing doc comments for a cell. Returns them in “/// comment” format, preserving original formatting.

pub fn reconstruct_cell( &self, cell_name: &str, new_function: &str, ) -> Result<String>

Reconstruct a complete cell including doc comments and attributes. Returns the full cell text: doc comments + #[venus::cell] + function.

pub fn reconstruct_and_get_span( &self, cell_name: &str, new_function: &str, ) -> Result<(String, usize, usize)>

Reconstruct a cell and get its line span in one call. Returns (reconstructed_text, start_line, end_line).