Úvod

Aspose.Cells FOSS pro Rust vystavuje svou funkčnost přes crate aspose-cells-foss-rust, soustředěnou na kompaktní sadu základních typů: Workbook, Worksheet, Cells, Cell a DocumentProperties, z nichž každý má odpovídající přístupové metody *Mut pro zápis. Tento příspěvek je systematickým průvodcem tímto jádrem API rozhraním — ne jednou úzkou funkcí, ale základními prvky, které každá aplikace postavená na tomto crate používá: vytváření a pojmenovávání listů, čtení a zápis typovaných hodnot buněk, nastavení metadat dokumentu, ochrana a skrytí listů, nastavení velikosti řádků a sloupců, slučování buněk a obranné načítání souborů.

Crate je licencován pod MIT a cílí na edici Rust 2021. Téměř každá operace, která může selhat, vrací Result<_, CellsError>, takže zpracování chyb s operátorem ? probíhá v příkladech níže stejným způsobem jako v reálném kódu. Crate si přitahuje malou sadu runtime závislostí místo toho, aby vše implementoval od začátku — chrono pro hodnoty data a času, zip pro formát balíčku XLSX, roxmltree pro parsování XML, serde_json pro strukturovaná data, sha2 a base64 pro hashování a kódování a getrandom pro náhodnost.

Každá následující sekce pokrývá jednu oblast API s konkrétními typy a metodami, podpořenými funkčními příklady v Rustu převzatými z ukázkového kódu crate.

Klíčové vlastnosti

Základy sešitu a listu

Workbook začíná prázdný s Workbook::new(), obsahuje jeden list pojmenovaný "Sheet1". Další listy se získávají pomocí WorksheetsMut::add(name), který vrací index nového listu. Worksheets/WorksheetsMut také sledují, který list je aktivní pomocí active_sheet_name() a set_active_sheet_name().

let mut workbook = Workbook::new();
{
    let mut worksheets = workbook.get_worksheets_mut();
    let sheet = worksheets.get(0)?;
    sheet.set_name("Summary")?;

    let detail_index = worksheets.add("Detail")?;
    let detail = worksheets.get(detail_index)?;
    detail.get_cells_mut().get("A1")?.put_value_string("Detail data")?;

    worksheets.set_active_sheet_name("Detail")?;
}

let sheets = workbook.get_worksheets();
println!("Worksheet count: {}", sheets.count());
println!("Active sheet: {}", sheets.active_sheet_name());

Typované hodnoty buněk a vzorce

Cells/CellsMut adresují buňku pomocí odkazu ve stylu A1 (get("B3")) nebo pomocí indexu řádku/sloupce (get_by_index(row, column)). Každý Cell/CellMut přijímá typované hodnoty přes dedikované settery, takže není potřeba žádných stringově typovaných konverzí, a vzorce jsou zapisovány spolu s cacheovanou hodnotou, takže soubor se otevře se správnými výsledky ještě před jakoukoliv přepočítáním.

let mut workbook = Workbook::new();
{
    let mut worksheets = workbook.get_worksheets_mut();
    let sheet = worksheets.get(0)?;
    let mut cells = sheet.get_cells_mut();

    cells.get("A1")?.put_value_string("Hello")?;
    cells.get("B1")?.put_value_i32(123)?;
    cells.get("C1")?.put_value_bool(true)?;
    cells.get("D1")?.put_value_decimal(12.5)?;
    cells.get("F1")?.put_value_i32(10)?;
    cells.get("G1")?
        .put_formula_with_cached_value("=F1*2", CellValue::Number(20.0))?;
}
workbook.save("typed-values.xlsx")?;

let loaded = Workbook::load_xlsx("typed-values.xlsx")?;
let sheet = loaded.worksheet("Sheet1")?;
let cells = sheet.get_cells();
println!(
    "{:?}: {}",
    cells.get("B1")?.value_type(),
    cells.get("B1")?.display_string_value()
);
println!("G1 cached value -> {}", cells.get("G1")?.display_string_value());

Vlastnosti dokumentu

Workbook::get_document_properties_mut() získává objekt DocumentProperties, který zahrnuje běžná metadata (název, předmět, autor, klíčová slova, kategorie, společnost), plus vnořený CoreDocumentProperties (get_core_mut()) a ExtendedDocumentProperties (get_extended_mut()) pro sady vlastností OOXML core/extended.

{
    let properties = workbook.get_document_properties_mut();
    properties.set_title("Annual Sales Report 2024");
    properties.set_subject("Financial Performance Analysis");
    properties.set_author("Finance Department");
    properties.set_keywords("sales, finance, 2024, report");
    properties.set_category("Financial Reports");
    properties.set_company("Acme Corporation");

    let core = properties.get_core_mut();
    core.set_creator("Finance Department");
    core.set_created(Some(Utc::now()));

    let extended = properties.get_extended_mut();
    extended.set_company("Acme Corporation");
}
workbook.save("with-properties.xlsx")?;

let loaded = Workbook::load_xlsx("with-properties.xlsx")?;
let properties = loaded.get_document_properties();
println!("Title: {}", properties.get_title());
println!("Core creator: {}", properties.get_core().get_creator());

Ochrana listu a viditelnost

Worksheet může být skrytý pomocí set_visibility_type(VisibilityType::Hidden), zbarvený pomocí set_tab_color a uzamčený pomocí protect() plus objekt WorksheetProtection (prostřednictvím get_protection_mut()), který přesně řídí, které akce — formátování buněk, výběr uzamčených buněk a podobně — zůstávají dostupné, jakmile je ochrana zapnuta.

let mut workbook = Workbook::new();
{
    let mut worksheets = workbook.get_worksheets_mut();
    let layout = worksheets.get(0)?;
    layout.set_name("Layout")?;
    layout.set_visibility_type(VisibilityType::Hidden);
    layout.set_tab_color(Color::from_argb(255, 34, 68, 102));
    layout.set_show_gridlines(false);
    layout.set_right_to_left(true);
    layout.set_zoom(85)?;
    layout.protect();

    let protection = layout.get_protection_mut();
    protection.set_objects(true);
    protection.set_format_cells(true);
    protection.set_select_locked_cells(true);
}
workbook.save("protected.xlsx")?;

let loaded = Workbook::load_xlsx("protected.xlsx")?;
let sheet = loaded.worksheet("Layout")?;
println!("Visibility: {:?}", sheet.get_visibility_type());
println!("Protected: {}", sheet.is_protected());

Řádky, sloupce a sloučené buňky

CellsMut vystavuje get_rows()/get_columns() jako RowsMut/ColumnsMut pro změnu velikosti a skrytí jednotlivých řádků a sloupců a merge(first_row, first_column, total_rows, total_columns) pro sloučení rozsahu buněk do jedné sloučené oblasti.

let mut workbook = Workbook::new();
{
    let mut worksheets = workbook.get_worksheets_mut();
    let sheet = worksheets.get(0)?;
    let mut cells = sheet.get_cells_mut();

    cells.get("A1")?.put_value_string("Merged")?;
    cells.get("C4")?.put_value_i32(99)?;
    cells.get_rows().get(1).set_height(22.5)?;
    cells.get_rows().get(3).set_is_hidden(true)?;
    cells.get_columns().get(0).set_width(18.25)?;
    cells.get_columns().get(2).set_is_hidden(true)?;

    let mut cells = sheet.get_cells_mut();
    cells.merge(0, 0, 2, 2)?;
}
workbook.save("rows-columns.xlsx")?;

let loaded = Workbook::load_xlsx("rows-columns.xlsx")?;
let sheet = loaded.worksheet("Sheet1")?;
println!(
    "Row 2 height: {}",
    sheet.get_rows().get(1).get_height().unwrap_or_default()
);
println!(
    "Column A width: {}",
    sheet.get_columns().get(0).get_width().unwrap_or_default()
);
println!("Merged regions: {}", sheet.get_cells().get_merged_cells().len());

Defenzivní načítání s diagnostikou

Reálné soubory XLSX nejsou vždy dobře formátované. LoadOptions vystavuje příznaky opravy (try_repair_package, try_repair_xml) a Workbook::get_load_diagnostics() vrací objekt LoadDiagnostics, jehož issues() hlásí, co načítač našel a opravil.

let options = LoadOptions {
    try_repair_package: true,
    try_repair_xml: true,
    ..LoadOptions::default()
};

let loaded = Workbook::load_xlsx_with_options(&path, &options)?;
let sheet = loaded.worksheet("Sheet1")?;
let cells = sheet.get_cells();

println!(
    "Loaded workbook with {} worksheet(s) and {} diagnostic issue(s).",
    loaded.get_worksheets().count(),
    loaded.get_load_diagnostics().issues().len()
);
println!("First item: {}", cells.get("A2")?.display_string_value());

Rychlý start

# Cargo.toml
[dependencies]
aspose-cells-foss-rust = { git = "https://github.com/aspose-cells-foss/Aspose.Cells-FOSS-for-Rust" }

Minimální relace zahrnující základní práci se sešitem, listem, buňkou a vlastnostmi dokumentu:

use aspose_cells_foss_rust::{CellValue, Workbook};
use std::error::Error;

fn main() -> Result<(), Box<dyn Error>> {
    let mut workbook = Workbook::new();
    {
        let mut worksheets = workbook.get_worksheets_mut();
        let sheet = worksheets.get(0)?;
        sheet.set_name("Report")?;

        let mut cells = sheet.get_cells_mut();
        cells.get("A1")?.put_value_string("Item")?;
        cells.get("B1")?.put_value_string("Quantity")?;
        cells.get("A2")?.put_value_string("Widgets")?;
        cells.get("B2")?.put_value_i32(12)?;
        cells.get("B3")?
            .put_formula_with_cached_value("=SUM(B2:B2)", CellValue::Number(12.0))?;
    }

    workbook.get_document_properties_mut().set_title("Quick Start Report");
    workbook.save("report.xlsx")?;

    let loaded = Workbook::load_xlsx("report.xlsx")?;
    let sheet = loaded.worksheet("Report")?;
    let cells = sheet.get_cells();
    println!("Title: {}", loaded.get_document_properties().get_title());
    println!("Total formula -> {}", cells.get("B3")?.display_string_value());

    Ok(())
}

Podporované formáty

FormátPříponaČístZapsat
XLSX.xlsx✓✓

XLSX je středobodem aktuálního vydání: kompletní round-trip čtení a zápis pomocí Workbook::load_xlsx a Workbook::save, s výčty LoadFormat a SaveFormat určujícími explicitní výběr formátu.

Open source a licencování

Aspose.Cells FOSS pro Rust je licencováno pod MIT. Kompletní zdrojový kód je dostupný na GitHub a licence povoluje komerční použití, úpravy a redistribuci.

Začínáme

Související zdroje