Struct SpreadsheetState 

pub struct SpreadsheetState { /* private fields */ }

A workbook with its selection and undo history, shared between a Spreadsheet and the application. Clones share the same workbook.

Every change goes through the engine’s commands (see Self::execute), which is how the toolbar, the keyboard and the application change it alike.

use ravenrs_spreadsheet::SpreadsheetState;

let sheet = SpreadsheetState::new();
sheet.set_cell("A1", "2").unwrap();
sheet.set_cell("A2", "=A1*21").unwrap();
assert_eq!(sheet.cell_text("A2"), "42");

Implementations

impl SpreadsheetState

pub fn new() -> Self

A new, empty workbook with one sheet.

pub fn open(name: &str, bytes: &[u8]) -> Result<Self, String>

Opens a workbook from the bytes of a file: .xlsx, .xlsm, .xls, .ods, .csv or .tsv, told apart by name’s extension and by the content.

pub fn replace(&self, name: &str, bytes: &[u8]) -> Result<(), String>

Replaces the workbook with the one in a file’s bytes, as Self::open reads them. Undo starts over.

pub fn execute(&self, command: &str, params: Json) -> Result<Json, String>

Runs one of the engine’s commands, such as cell.set, home.bold or edit.undo, with its parameters, and gives what it answered. A refused command changes nothing and its reason shows under the formula bar.

pub fn set_cell(&self, cell: &str, input: &str) -> Result<(), String>

Types input into a cell given as A1: a number, text, a date or a =formula, read as a person typing it would be.

pub fn cell_text(&self, cell: &str) -> String

What a cell given as A1 shows on the active sheet, with its number format applied.

pub fn cell_input(&self, cell: &str) -> String

What editing a cell given as A1 starts from: its formula, or the value as typed.

pub fn active_cell(&self) -> String

The active cell, as A1.

pub fn selection(&self) -> String

The selection, as A1:B2 (areas joined by commas).

pub fn select(&self, range: &str) -> Result<(), String>

Selects a cell or a range given as A1 or A1:C3.

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

The names of the sheets, in order.

pub fn active_sheet(&self) -> usize

The position of the sheet being shown.

pub fn to_xlsx(&self) -> Result<Vec<u8>, String>

The workbook as an .xlsx file.

pub fn to_csv(&self) -> Result<Vec<u8>, String>

The active sheet’s values as CSV.

pub fn file_name(&self) -> String

The name Save offers, ending in .xlsx.

pub fn set_file_name(&self, name: &str)

Changes the name Save offers; .xlsx is added when missing.

pub fn can_undo(&self) -> bool

Whether there is something to undo.

pub fn can_redo(&self) -> bool

Whether there is something to redo.

pub fn read<R>(&self, f: impl FnOnce(&Workbook) -> R) -> R

Reads the workbook, for anything the methods here do not cover.

pub fn version(&self) -> u64

Goes up after every change: reading it in a view rebuilds that view on the next one.

pub fn with_session<R>(&self, f: impl FnOnce(&mut Session) -> R) -> R

Runs f with the engine’s session, for commands with replies or state not covered here. Views showing the workbook rebuild afterwards.

pub fn error(&self) -> Option<String>

The latest refusal from the engine, if the last command was refused.

Trait Implementations

impl Clone for SpreadsheetState

fn clone(&self) -> SpreadsheetState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpreadsheetState

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

Formats the value using the given formatter.

impl Default for SpreadsheetState

fn default() -> Self

Returns the “default value” for a type.