Struct WorkbookSession 

pub struct WorkbookSession { /* private fields */ }

Surface-agnostic in-memory workbook session.

This API avoids workbook IDs, fork handles, and MCP-specific wiring so it can be reused by CLI, SDK, or WASM bindings.

Implementations

impl WorkbookSession

pub fn from_bytes(bytes: impl AsRef<[u8]>) -> Result<Self>

Open a workbook session from raw XLSX bytes.

pub fn from_path(path: impl AsRef<Path>) -> Result<Self>

Open a workbook session from a filesystem path.

pub fn list_sheets(&self) -> Vec<String>

Return sheet names in workbook order.

pub fn describe_workbook(&self) -> Result<WorkbookDescription>

Return workbook-level descriptor for this in-memory session.

pub fn named_ranges(&self) -> Result<NamedRangesResponse>

Return workbook defined names and table descriptors.

pub fn define_name( &mut self, name: &str, refers_to: &str, scope: Option<&str>, scope_sheet_name: Option<&str>, ) -> Result<DefineNameResponse>

Define a new named range.

pub fn update_name( &mut self, name: &str, refers_to: Option<&str>, scope: Option<&str>, scope_sheet_name: Option<&str>, ) -> Result<UpdateNameResponse>

Update an existing named range.

pub fn delete_name( &mut self, name: &str, scope: Option<&str>, scope_sheet_name: Option<&str>, ) -> Result<DeleteNameResponse>

Delete a named range.

pub fn sheet_overview( &self, params: SessionSheetOverviewParams, ) -> Result<SheetOverviewResponse>

Return overview/classification information for a sheet.

pub fn find_value( &self, params: SessionFindValueParams, ) -> Result<FindValueResponse>

Search for values in one sheet or across all sheets.

pub fn read_table( &self, params: SessionReadTableParams, ) -> Result<ReadTableResponse>

Read a rectangular table snapshot from a sheet.

pub fn range_values( &self, sheet_name: &str, ranges: impl Into<SessionRangeSelection>, ) -> Result<Vec<RangeValuesEntry>>

Read one or more A1 ranges from a sheet.

pub fn sheet_page( &self, params: SessionSheetPageParams, ) -> Result<SheetPageResponse>

Read a page-oriented snapshot from a sheet.

pub fn grid_export(&self, sheet_name: &str, range: &str) -> Result<GridPayload>

Export a range as grid payload (value/formula/style patch surface).

pub fn apply_ops( &mut self, ops: &[SessionTransformOp], ) -> Result<SessionApplySummary>

Apply a transform batch in-session.

For this extraction pass we support write_matrix operations.

pub fn apply_write_matrix( &mut self, sheet_name: impl Into<String>, anchor: impl Into<String>, rows: Vec<Vec<Option<SessionMatrixCell>>>, overwrite_formulas: bool, ) -> Result<SessionApplySummary>

Convenience wrapper for a single write_matrix operation.

pub fn to_bytes(&self) -> Result<Vec<u8>>

Serialize the current in-memory workbook state back to XLSX bytes.

pub fn to_temp_file(&self) -> Result<NamedTempFile>

Write current workbook state to a temporary XLSX file.

The caller owns the NamedTempFile and must keep it alive for as long as the path is needed (e.g. during apply-to-file round-trips).

pub fn reload_from_path(&mut self, path: &Path) -> Result<()>

Reload in-memory workbook state from an on-disk XLSX file.

Used after an external apply_*_to_file() function has mutated the file to bring the session back in sync.

pub fn into_bytes(self) -> Result<Vec<u8>>

Serialize and consume the current in-memory workbook state.

pub fn sheet_by_name(&self, sheet_name: &str) -> Option<&Worksheet>

Look up a sheet by name, returning Some if found.