Struct spreadsheet_ods::refs::CellRange

pub struct CellRange { /* private fields */ }

A cell-range.

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

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

Implementations

impl CellRange

pub fn new_all( iri: Option<String>, from_table: Option<String>, from_row_abs: bool, from_row: u32, from_col_abs: bool, from_col: u32, to_table: Option<String>, to_row_abs: bool, to_row: u32, to_col_abs: bool, to_col: u32 ) -> Self

Create a CellRange with all possible arguments.

pub fn new() -> Self

Empty

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

Creates the cell range from from + to data.

Panic

If row > to_row or col > to_col.

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

Creates the cell range from from + to data.

Panic

If row > to_row or col > to_col.

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

Creates the cell range from origin + spanning data.

Panic

Both span values must be > 0.

pub fn set_iri<S: Into<String>>(&mut self, iri: S)

External file

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

External file

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: u32)

Row

pub fn row(&self) -> u32

Row

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: u32)

Column

pub fn col(&self) -> u32

Column

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

“$” column reference

pub fn col_abs(&self) -> bool

“$” column reference

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

Table name for references into other tables.

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

Table name for references into other tables.

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

To row

pub fn to_row(&self) -> u32

To row

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: u32)

To column

pub fn to_col(&self) -> u32

To column

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 absolute(self) -> Self

Makes this CellReference into an absolute reference.

pub fn absolute_rows(self) -> Self

Makes this CellReference into an absolute reference. The columns remain relative, the rows are fixed.

pub fn absolute_cols(self) -> Self

Makes this CellReference into an absolute reference. The rows remain relative, the columns are fixed.

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

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

pub fn out_looped(&self, row: u32, col: u32) -> 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.

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

Formats the value using the given formatter.

impl GetSize for CellRange

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for CellRange

type Error = OdsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for CellRange

impl StructuralPartialEq for CellRange