Struct spreadsheet_ods::refs::CellRange

pub struct CellRange { /* fields omitted */ }

A cell-range.

As usual for a spreadsheet this is meant as inclusive from and to.

use spreadsheet_ods::CellRange;
let r1 = CellRange::local(0, 0, 9, 9);
let r2 = CellRange::origin_span(5, 5, (3, 3));

Implementations

impl CellRange

pub fn new() -> Self

pub fn local(row: ucell, col: ucell, to_row: ucell, to_col: ucell) -> Self

Creates the cell range from from + to data.

pub fn remote<S: Into<String>>(
    table: S,
    row: ucell,
    col: ucell,
    to_row: ucell,
    to_col: ucell
) -> Self

Creates the cell range from from + to data.

pub fn origin_span(row: ucell, col: ucell, span: (ucell, ucell)) -> Self

Creates the cell range from origin + spanning data.

pub fn set_table<S: Into<String>>(&mut self, table: S)

Table name for references into other tables.

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

Table name for references into other tables.

pub fn set_row(&mut self, row: ucell)

pub fn row(&self) -> ucell

pub fn set_row_abs(&mut self, abs: bool)

“$” row reference

pub fn row_abs(&self) -> bool

“$” row reference

pub fn set_col(&mut self, col: ucell)

pub fn col(&self) -> ucell

pub fn set_col_abs(&mut self, abs: bool)

“$” column reference

pub fn col_abs(&self) -> bool

“$” column reference

pub fn set_to_row(&mut self, to_row: ucell)

pub fn to_row(&self) -> ucell

pub fn set_to_row_abs(&mut self, abs: bool)

“$” row reference

pub fn to_row_abs(&self) -> bool

“$” row reference

pub fn set_to_col(&mut self, to_col: ucell)

pub fn to_col(&self) -> ucell

pub fn set_to_col_abs(&mut self, abs: bool)

“$” column reference

pub fn to_col_abs(&self) -> bool

“$” column reference

pub fn to_formula(&self) -> String

Returns a range reference for a formula.

pub fn contains(&self, row: ucell, col: ucell) -> bool

Does the range contain the cell. This is inclusive for to_row and to_col!

pub fn out_looped(&self, row: ucell, col: ucell) -> bool

Is this range any longer relevant, when looping rows first, then columns?

Trait Implementations

impl Clone for CellRange

fn clone(&self) -> CellRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CellRange

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

Formats the value using the given formatter.

impl Default for CellRange

fn default() -> CellRange

Returns the “default value” for a type.

impl Display for CellRange

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

Formats the value using the given formatter.

impl Eq for CellRange

impl PartialEq<CellRange> for CellRange

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for CellRange

impl StructuralPartialEq for CellRange

impl TryFrom<&'_ str> for CellRange

type Error = OdsError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.