Enum ReferenceType 

pub enum ReferenceType {
    Cell {
        sheet: Option<String>,
        row: u32,
        col: u32,
        row_abs: bool,
        col_abs: bool,
    },
    Range {
        sheet: Option<String>,
        start_row: Option<u32>,
        start_col: Option<u32>,
        end_row: Option<u32>,
        end_col: Option<u32>,
        start_row_abs: bool,
        start_col_abs: bool,
        end_row_abs: bool,
        end_col_abs: bool,
    },
    Cell3D {
        sheet_first: String,
        sheet_last: String,
        row: u32,
        col: u32,
        row_abs: bool,
        col_abs: bool,
    },
    Range3D {
        sheet_first: String,
        sheet_last: String,
        start_row: Option<u32>,
        start_col: Option<u32>,
        end_row: Option<u32>,
        end_col: Option<u32>,
        start_row_abs: bool,
        start_col_abs: bool,
        end_row_abs: bool,
        end_col_abs: bool,
    },
    External(ExternalReference),
    Table(TableReference),
    NamedRange(String),
}

A reference to something outside the cell.

Variants

Cell

Fields

sheet: Option<String>

row: u32

col: u32

row_abs: bool

col_abs: bool

Range

Fields

sheet: Option<String>

start_row: Option<u32>

start_col: Option<u32>

end_row: Option<u32>

end_col: Option<u32>

start_row_abs: bool

start_col_abs: bool

end_row_abs: bool

end_col_abs: bool

Cell3D

3D cell reference (Sheet1:Sheet3!A1).

Excel evaluates aggregating functions across each sheet between sheet_first and sheet_last (inclusive) at the same cell address.

Fields

sheet_first: String

sheet_last: String

row: u32

col: u32

row_abs: bool

col_abs: bool

Range3D

3D range reference (Sheet1:Sheet3!A1:B2).

Fields

sheet_first: String

sheet_last: String

start_row: Option<u32>

start_col: Option<u32>

end_row: Option<u32>

end_col: Option<u32>

start_row_abs: bool

start_col_abs: bool

end_row_abs: bool

end_col_abs: bool

External(ExternalReference)

Table(TableReference)

NamedRange(String)

Implementations

impl ReferenceType

pub fn cell(sheet: Option<String>, row: u32, col: u32) -> Self

Build a cell reference with relative anchors.

pub fn cell_with_abs( sheet: Option<String>, row: u32, col: u32, row_abs: bool, col_abs: bool, ) -> Self

Build a cell reference with explicit anchors.

pub fn range( sheet: Option<String>, start_row: Option<u32>, start_col: Option<u32>, end_row: Option<u32>, end_col: Option<u32>, ) -> Self

Build a range reference with relative anchors.

pub fn range_with_abs( sheet: Option<String>, start_row: Option<u32>, start_col: Option<u32>, end_row: Option<u32>, end_col: Option<u32>, start_row_abs: bool, start_col_abs: bool, end_row_abs: bool, end_col_abs: bool, ) -> Self

Build a range reference with explicit anchors.

pub fn from_string(reference: &str) -> Result<Self, ParsingError>

Create a reference from a string. Can be A1, A:A, A1:B2, Table1[Column], etc.

pub fn from_string_with_dialect( reference: &str, dialect: FormulaDialect, ) -> Result<Self, ParsingError>

Create a reference from a string using the specified formula dialect.

pub fn parse_sheet_ref( reference: &str, ) -> Result<SheetRef<'static>, ParsingError>

Parse a grid reference into a shared SheetRef, preserving $ anchors.

Only cell and range references are supported. Table and named ranges return an error.

pub fn parse_sheet_ref_with_dialect( reference: &str, dialect: FormulaDialect, ) -> Result<SheetRef<'static>, ParsingError>

Parse a grid reference into a shared SheetRef using the specified dialect.

pub fn to_sheet_ref_lossy(&self) -> Option<SheetRef<'_>>

Lossy conversion from parsed ReferenceType into SheetRef. External, table, and named ranges are discarded; anchors are preserved.

impl ReferenceType

pub fn normalise(&self) -> String

Normalise the reference string (convert to canonical form)

pub fn to_excel_string(&self) -> String

Get the Excel-style string representation of this reference

Trait Implementations

impl Clone for ReferenceType

fn clone(&self) -> ReferenceType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferenceType

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

Formats the value using the given formatter.

impl Display for ReferenceType

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

Formats the value using the given formatter.

impl<'a> From<&'a ReferenceType> for RefView<'a>

fn from(r: &'a ReferenceType) -> Self

Converts to this type from the input type.

impl FromStr for ReferenceType

type Err = ParsingError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ReferenceType

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 ReferenceType

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&str> for ReferenceType

type Error = ParsingError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for ReferenceType