Введение

Aspose.Cells FOSS для Rust раскрывает свою функциональность через crate aspose-cells-foss-rust, сосредоточенную на компактном наборе основных типов: Workbook, Worksheet, Cells, Cell и DocumentProperties, каждый из которых имеет соответствующие аксессоры *Mut для записи. Эта статья представляет собой систематический обзор основной поверхности API — не одну узкую возможность, а фундаментальные элементы, которые использует каждое приложение, построенное на этом crate: создание и именование листов, чтение и запись типизированных значений ячеек, установка метаданных документа, защита и скрытие листов, настройка размеров строк и столбцов, объединение ячеек и безопасная загрузка файлов.

Crate лицензируется по MIT и нацелен на выпуск Rust 2021 года. Почти каждая потенциально ошибочная операция возвращает Result<_, CellsError>, поэтому обработка ошибок с оператором ? проходит через приведённые ниже примеры так же, как и в реальном коде. Crate подтягивает небольшой набор зависимостей времени выполнения, вместо того чтобы реализовывать всё с нуля — chrono для значений даты и времени, zip для формата пакета XLSX, roxmltree для разбора XML, serde_json для структурированных данных, sha2 и base64 для хеширования и кодирования, а также getrandom для генерации случайных чисел.

Каждый раздел ниже охватывает одну область API с конкретными типами и методами, поддержанными работающими примерами Rust, взятыми из образцового кода crate.

Ключевые возможности

Основы рабочей книги и листа

Workbook начинается пустым с Workbook::new(), содержащим один лист с именем "Sheet1". Дополнительные листы создаются с помощью WorksheetsMut::add(name), который возвращает индекс нового листа. Worksheets/WorksheetsMut также отслеживают, какой лист активен, через active_sheet_name() и 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());

Типизированные значения ячеек и формулы

Cells/CellsMut адресуют ячейку по ссылке в стиле A1 (get("B3")) или по индексу строки/столбца (get_by_index(row, column)). Каждый Cell/CellMut принимает типизированные значения через специальные сеттеры, поэтому преобразования строковых типов не требуются, а формулы записываются вместе с кэшированным значением, чтобы файл открывался с правильными результатами до любой перерасчётa.

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());

Свойства документа

Workbook::get_document_properties_mut() получает объект DocumentProperties, охватывающий общие поля метаданных (title, subject, author, keywords, category, company), а также вложенный CoreDocumentProperties (get_core_mut()) и ExtendedDocumentProperties (get_extended_mut()) для наборов свойств 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());

Защита и видимость листа

Объект Worksheet можно скрыть с помощью set_visibility_type(VisibilityType::Hidden), окрасить с помощью set_tab_color и заблокировать с помощью protect() плюс объект WorksheetProtection (через get_protection_mut()), который точно контролирует, какие действия — форматирование ячеек, выбор заблокированных ячеек и т.д. — остаются доступными после включения защиты.

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());

Строки, столбцы и объединённые ячейки

CellsMut предоставляет get_rows()/get_columns() как RowsMut/ColumnsMut для изменения размера и скрытия отдельных строк и столбцов, а также merge(first_row, first_column, total_rows, total_columns) для объединения диапазона ячеек в одну объединённую область.

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());

Защитная загрузка с диагностикой

Реальные XLSX-файлы не всегда корректно сформированы. LoadOptions раскрывает флаги восстановления (try_repair_package, try_repair_xml), а Workbook::get_load_diagnostics() возвращает объект LoadDiagnostics, чьи issues() сообщают, что загрузчик нашёл и исправил.

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());

Быстрый старт

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

Минимальная сессия, затрагивающая workbook, worksheet, cell и основы document-property:

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(())
}

Поддерживаемые форматы

ФорматРасширениеЧитатьЗаписать
XLSX.xlsx✓✓

XLSX является основной в текущем релизе: полное чтение и запись в обе стороны через Workbook::load_xlsx и Workbook::save, с перечислениями LoadFormat и SaveFormat, управляющими явным выбором формата.

Открытый исходный код и лицензирование

Aspose.Cells FOSS для Rust имеет лицензию MIT. Полный исходный код доступен на GitHub, и лицензия разрешает коммерческое использование, модификацию и распространение.

Начало работы

Сопутствующие ресурсы