Struct Workbook 

pub struct Workbook { /* private fields */ }

Engine-backed workbook facade.

Implementations

impl Workbook

pub fn new_with_config(config: EvalConfig) -> Self

pub fn new() -> Self

pub fn engine(&self) -> &Engine<WBResolver>

pub fn engine_mut(&mut self) -> &mut Engine<WBResolver>

pub fn set_changelog_enabled(&mut self, enabled: bool)

pub fn begin_action(&mut self, description: impl Into<String>)

pub fn end_action(&mut self)

pub fn undo(&mut self) -> Result<(), IoError>

pub fn redo(&mut self) -> Result<(), IoError>

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

pub fn sheet_dimensions(&self, name: &str) -> Option<(u32, u32)>

Return (rows, cols) for a sheet if present in the Arrow store

pub fn has_sheet(&self, name: &str) -> bool

pub fn add_sheet(&mut self, name: &str)

pub fn delete_sheet(&mut self, name: &str)

pub fn rename_sheet(&mut self, old: &str, new: &str)

pub fn set_value( &mut self, sheet: &str, row: u32, col: u32, value: LiteralValue, ) -> Result<(), IoError>

pub fn set_formula( &mut self, sheet: &str, row: u32, col: u32, formula: &str, ) -> Result<(), IoError>

pub fn get_value(&self, sheet: &str, row: u32, col: u32) -> Option<LiteralValue>

pub fn get_formula(&self, sheet: &str, row: u32, col: u32) -> Option<String>

pub fn read_range(&self, addr: &RangeAddress) -> Vec<Vec<LiteralValue>>

pub fn write_range( &mut self, sheet: &str, _start: (u32, u32), cells: BTreeMap<(u32, u32), CellData>, ) -> Result<(), IoError>

pub fn set_values( &mut self, sheet: &str, start_row: u32, start_col: u32, rows: &[Vec<LiteralValue>], ) -> Result<(), IoError>

pub fn set_formulas( &mut self, sheet: &str, start_row: u32, start_col: u32, rows: &[Vec<String>], ) -> Result<(), IoError>

pub fn prepare_graph_all(&mut self) -> Result<(), IoError>

pub fn prepare_graph_for_sheets<'a, I: IntoIterator<Item = &'a str>>( &mut self, sheets: I, ) -> Result<(), IoError>

pub fn evaluate_cell( &mut self, sheet: &str, row: u32, col: u32, ) -> Result<LiteralValue, IoError>

pub fn evaluate_cells( &mut self, targets: &[(&str, u32, u32)], ) -> Result<Vec<LiteralValue>, IoError>

pub fn evaluate_all(&mut self) -> Result<EvalResult, IoError>

pub fn evaluate_with_plan( &mut self, plan: &RecalcPlan, ) -> Result<EvalResult, IoError>

pub fn named_range_address(&self, name: &str) -> Option<RangeAddress>

Resolve a named range (workbook-scoped or unique sheet-scoped) to an absolute address.

pub fn begin_tx<'a, W: SpreadsheetWriter>( &'a mut self, writer: &'a mut W, ) -> WriteTransaction<'a, W>

pub fn from_reader<B: SpreadsheetReader>( backend: B, strategy: LoadStrategy, config: EvalConfig, ) -> Result<Self, IoError>

Trait Implementations

impl Default for Workbook

fn default() -> Self

Returns the “default value” for a type.

impl SpreadsheetWriter for Workbook

type Error = IoError

fn write_cell( &mut self, sheet: &str, row: u32, col: u32, data: CellData, ) -> Result<(), Self::Error>

fn write_range( &mut self, sheet: &str, cells: BTreeMap<(u32, u32), CellData>, ) -> Result<(), Self::Error>

fn clear_range( &mut self, sheet: &str, start: (u32, u32), end: (u32, u32), ) -> Result<(), Self::Error>

fn create_sheet(&mut self, name: &str) -> Result<(), Self::Error>

fn delete_sheet(&mut self, name: &str) -> Result<(), Self::Error>

fn rename_sheet(&mut self, old: &str, new: &str) -> Result<(), Self::Error>

fn flush(&mut self) -> Result<(), Self::Error>

fn save(&mut self) -> Result<(), Self::Error>

fn save_to<'a>( &mut self, dest: SaveDestination<'a>, ) -> Result<Option<Vec<u8>>, Self::Error>

Advanced save: specify destination (in place, path, writer, or bytes in memory). Returns Ok(Some(bytes)) only for Bytes destination, else Ok(None).

fn save_as_path<P: AsRef<Path>>(&mut self, path: P) -> Result<(), Self::Error>

fn save_to_bytes(&mut self) -> Result<Vec<u8>, Self::Error>

fn write_to<W: Write>(&mut self, writer: &mut W) -> Result<(), Self::Error>