Struct Worksheet 

pub struct Worksheet { /* private fields */ }

A named sheet holding a sparse cell grid (schema spec §3).

Cell keys are plain uppercase A1 addresses (A1, BC42) — no $, no sheet qualifier, no lowercase. Absent addresses are empty cells and are never serialized. The map is ordered (BTreeMap), which matches the canonical (JCS) key order for ASCII A1 addresses: A10 sorts before A2.

The typed grid API (get / set / clear, keyed by a bounds-validated Address) is the in-memory accessor used by the recalc runtime (plan item 3.1); the raw cells map is retained for the serde layer. Address-syntax and sheet-name validation against the schema’s normative rules also happens at the serialization boundary (Workbook::from_json), independently of the typed API, since from_json parses untrusted keys.

Implementations

impl Worksheet

pub fn new(name: impl Into<String>) -> Self

Creates an empty worksheet named name.

pub fn name(&self) -> &str

The sheet name, unique within a workbook (case-insensitive).

pub fn cells(&self) -> &BTreeMap<String, Cell>

The sparse cell grid, keyed by plain uppercase A1 address.

pub fn cells_mut(&mut self) -> &mut BTreeMap<String, Cell>

Mutable access to the sparse cell grid.

pub fn get(&self, addr: Address) -> Option<&Cell>

The cell at addr, or None if that address is empty.

pub fn get_mut(&mut self, addr: Address) -> Option<&mut Cell>

Mutable access to the cell at addr, or None if that address is empty.

pub fn set(&mut self, addr: Address, cell: Cell) -> Option<Cell>

Writes cell at addr, returning the cell previously there (if any).

addr is already bounds-validated by construction, so a set never escapes the address bounds. To clear a cell use clear, never a set of an empty value (schema spec §4).

pub fn clear(&mut self, addr: Address) -> Option<Cell>

Removes the cell at addr, returning it if present.

Clearing a cell is removing its entry, never writing an empty value: an empty entry would be byte-distinguishable from the absent cell it denotes (schema spec §4).

pub fn contains(&self, addr: Address) -> bool

Whether a cell is present at addr.

pub fn len(&self) -> usize

The number of populated cells.

pub fn is_empty(&self) -> bool

Whether the grid has no populated cells.

pub fn iter(&self) -> impl Iterator<Item = (Address, &Cell)>

Iterates the populated cells in canonical (JCS) key order, yielding the parsed Address for each. Keys held by a worksheet are always valid A1, so parsing cannot fail.

Trait Implementations

impl Clone for Worksheet

fn clone(&self) -> Worksheet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Worksheet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Worksheet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Worksheet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Worksheet

fn eq(&self, other: &Worksheet) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Worksheet

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Worksheet