Struct SortState 

pub struct SortState {
    pub range: String,
    pub conditions: Vec<SortCondition>,
}

A remembered sort order (<sortState>, CT_SortState). Written in two different places depending on context: as a child of a worksheet-level <autoFilter> (Sheet::sort_state) or as a sibling of a table’s own <autoFilter> (ExcelTable::sort_state) — see each field’s own doc comment for the exact schema positioning, confirmed via sml.xsd’s CT_AutoFilter/ CT_Table sequences. Only the simplest, most common shape is modeled: a plain value-based ascending/descending sort per range (ST_SortBy’s "value", the schema default) — sortBy="cellColor"/ "fontColor"/"icon", customList, and dxfId/iconSet/iconId (color/ icon-based custom sort criteria) are not modeled, same “the common case, not every historical Excel option” posture as SheetProtection/AutoFilterColumn. Storage only — this crate does not itself reorder any rows, see ExcelTable.sort_state’s doc comment.

Fields

range: String

The overall range this sort applies to (ref, required) — e.g. the table’s own data range, or the autofiltered range.

conditions: Vec<SortCondition>

Up to 64 sort keys, in priority order (<sortCondition>, CT_SortState’s own maxOccurs="64" limit — not enforced here, same “caller’s responsibility” posture as elsewhere in this crate).

Implementations

impl SortState

pub fn new(range: impl Into<String>) -> SortState

Creates a sort state over range with no sort keys yet.

Examples found in repository

examples/xlsx_tables.rs (line 78)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("xlsx_tables.xlsx");

    let plain_sheet = Sheet::new("Plain table")
        .with_row(Row::new().with_text("Name").with_text("Score"))
        .with_row(Row::new().with_text("Alice").with_number(92.0))
        .with_row(Row::new().with_text("Bob").with_number(87.0))
        .with_table(ExcelTable::new(
            "ScoresTable",
            "A1:B3",
            vec!["Name", "Score"],
        ));

    let calculated_sheet = Sheet::new("Calculated and totals")
        .with_row(
            Row::new()
                .with_text("Item")
                .with_text("Qty")
                .with_text("Unit price")
                .with_text("Line total"),
        )
        .with_row(
            Row::new()
                .with_text("Widget")
                .with_number(3.0)
                .with_number(9.99)
                .with_cell(Cell::formula("B2*C2").with_cached_value(29.97)),
        )
        .with_row(
            Row::new()
                .with_text("Gadget")
                .with_number(2.0)
                .with_number(19.99)
                .with_cell(Cell::formula("B3*C3").with_cached_value(39.98)),
        )
        .with_row(Row::new().with_cell(Cell::text("Total")))
        .with_table(
            ExcelTable::with_columns(
                "OrdersTable",
                "A1:D4",
                vec![
                    TableColumn::new("Item"),
                    TableColumn::new("Qty").with_totals_row_function(TotalsRowFunction::Sum),
                    TableColumn::new("Unit price"),
                    TableColumn::new("Line total")
                        .with_calculated_formula(
                            "OrdersTable[[#This Row],[Qty]]*OrdersTable[[#This Row],[Unit price]]",
                        )
                        .with_totals_row_function(TotalsRowFunction::Sum),
                ],
            )
            .with_totals_row(true),
        );

    let styled_sheet = Sheet::new("Custom style and sort")
        .with_row(Row::new().with_text("City").with_text("Population"))
        .with_row(Row::new().with_text("Springfield").with_number(120_000.0))
        .with_row(Row::new().with_text("Shelbyville").with_number(95_000.0))
        .with_table(
            ExcelTable::new("CitiesTable", "A1:B3", vec!["City", "Population"])
                .with_table_style_name("CustomTableStyle")
                .with_sort_state(
                    SortState::new("A2:B3")
                        .with_condition(SortCondition::new("B2:B3").with_descending(true)),
                ),
        );

    let workbook = Workbook::new()
        .with_table_style(
            TableStyle::new("CustomTableStyle")
                .with_element(TableStyleElement::new(
                    TableStyleElementType::HeaderRow,
                    CellFormat::new()
                        .with_bold(true)
                        .with_fill_color("FF2E74B5")
                        .with_font_color("FFFFFFFF"),
                ))
                .with_element(TableStyleElement::new(
                    TableStyleElementType::FirstRowStripe,
                    CellFormat::new().with_fill_color("FFF2F2F2"),
                )),
        )
        .with_sheet(plain_sheet)
        .with_sheet(calculated_sheet)
        .with_sheet(styled_sheet);

    workbook.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_condition(self, condition: SortCondition) -> SortState

Appends a sort key and returns the sort state for chaining.

Examples found in repository

examples/xlsx_tables.rs (line 79)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("xlsx_tables.xlsx");

    let plain_sheet = Sheet::new("Plain table")
        .with_row(Row::new().with_text("Name").with_text("Score"))
        .with_row(Row::new().with_text("Alice").with_number(92.0))
        .with_row(Row::new().with_text("Bob").with_number(87.0))
        .with_table(ExcelTable::new(
            "ScoresTable",
            "A1:B3",
            vec!["Name", "Score"],
        ));

    let calculated_sheet = Sheet::new("Calculated and totals")
        .with_row(
            Row::new()
                .with_text("Item")
                .with_text("Qty")
                .with_text("Unit price")
                .with_text("Line total"),
        )
        .with_row(
            Row::new()
                .with_text("Widget")
                .with_number(3.0)
                .with_number(9.99)
                .with_cell(Cell::formula("B2*C2").with_cached_value(29.97)),
        )
        .with_row(
            Row::new()
                .with_text("Gadget")
                .with_number(2.0)
                .with_number(19.99)
                .with_cell(Cell::formula("B3*C3").with_cached_value(39.98)),
        )
        .with_row(Row::new().with_cell(Cell::text("Total")))
        .with_table(
            ExcelTable::with_columns(
                "OrdersTable",
                "A1:D4",
                vec![
                    TableColumn::new("Item"),
                    TableColumn::new("Qty").with_totals_row_function(TotalsRowFunction::Sum),
                    TableColumn::new("Unit price"),
                    TableColumn::new("Line total")
                        .with_calculated_formula(
                            "OrdersTable[[#This Row],[Qty]]*OrdersTable[[#This Row],[Unit price]]",
                        )
                        .with_totals_row_function(TotalsRowFunction::Sum),
                ],
            )
            .with_totals_row(true),
        );

    let styled_sheet = Sheet::new("Custom style and sort")
        .with_row(Row::new().with_text("City").with_text("Population"))
        .with_row(Row::new().with_text("Springfield").with_number(120_000.0))
        .with_row(Row::new().with_text("Shelbyville").with_number(95_000.0))
        .with_table(
            ExcelTable::new("CitiesTable", "A1:B3", vec!["City", "Population"])
                .with_table_style_name("CustomTableStyle")
                .with_sort_state(
                    SortState::new("A2:B3")
                        .with_condition(SortCondition::new("B2:B3").with_descending(true)),
                ),
        );

    let workbook = Workbook::new()
        .with_table_style(
            TableStyle::new("CustomTableStyle")
                .with_element(TableStyleElement::new(
                    TableStyleElementType::HeaderRow,
                    CellFormat::new()
                        .with_bold(true)
                        .with_fill_color("FF2E74B5")
                        .with_font_color("FFFFFFFF"),
                ))
                .with_element(TableStyleElement::new(
                    TableStyleElementType::FirstRowStripe,
                    CellFormat::new().with_fill_color("FFF2F2F2"),
                )),
        )
        .with_sheet(plain_sheet)
        .with_sheet(calculated_sheet)
        .with_sheet(styled_sheet);

    workbook.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

Trait Implementations

impl Clone for SortState

fn clone(&self) -> SortState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SortState

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

Formats the value using the given formatter.

impl PartialEq for SortState

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SortState