Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jmcnamara/rust_xlsxwriter

A Rust library for creating Excel XLSX files.
https://github.com/jmcnamara/rust_xlsxwriter

libxlsxwriter rust xlsx xlsxwriter

Last synced: 12 days ago
JSON representation

A Rust library for creating Excel XLSX files.

Awesome Lists containing this project

README 

        
# rust_xlsxwriter



The `rust_xlsxwriter` library is a Rust library for writing Excel files in

the xlsx format.






The `rust_xlsxwriter` library can be used to write text, numbers, dates and

formulas to multiple worksheets in a new Excel 2007+ xlsx file. It has a focus

on performance and on fidelity with the file format created by Excel. It cannot

be used to modify an existing file.



## Example



Sample code to generate the Excel file shown above.



```rust

use rust_xlsxwriter::*;



fn main() -> Result<(), XlsxError> {

    // Create a new Excel file object.

    let mut workbook = Workbook::new();



    // Create some formats to use in the worksheet.

    let bold_format = Format::new().set_bold();

    let decimal_format = Format::new().set_num_format("0.000");

    let date_format = Format::new().set_num_format("yyyy-mm-dd");

    let merge_format = Format::new()

        .set_border(FormatBorder::Thin)

        .set_align(FormatAlign::Center);



    // Add a worksheet to the workbook.

    let worksheet = workbook.add_worksheet();



    // Set the column width for clarity.

    worksheet.set_column_width(0, 22)?;



    // Write a string without formatting.

    worksheet.write(0, 0, "Hello")?;



    // Write a string with the bold format defined above.

    worksheet.write_with_format(1, 0, "World", &bold_format)?;



    // Write some numbers.

    worksheet.write(2, 0, 1)?;

    worksheet.write(3, 0, 2.34)?;



    // Write a number with formatting.

    worksheet.write_with_format(4, 0, 3.00, &decimal_format)?;



    // Write a formula.

    worksheet.write(5, 0, Formula::new("=SIN(PI()/4)"))?;



    // Write a date.

    let date = ExcelDateTime::from_ymd(2023, 1, 25)?;

    worksheet.write_with_format(6, 0, &date, &date_format)?;



    // Write some links.

    worksheet.write(7, 0, Url::new("https://www.rust-lang.org"))?;

    worksheet.write(8, 0, Url::new("https://www.rust-lang.org").set_text("Rust"))?;



    // Write some merged cells.

    worksheet.merge_range(9, 0, 9, 1, "Merged cells", &merge_format)?;



    // Insert an image.

    let image = Image::new("examples/rust_logo.png")?;

    worksheet.insert_image(1, 2, &image)?;



    // Save the file to disk.

    workbook.save("demo.xlsx")?;



    Ok(())

}

```



`rust_xlsxwriter` is a rewrite of the Python [`XlsxWriter`] library in Rust by

the same author and with some additional Rust-like features and APIs. The

currently supported features are:



- Support for writing all basic Excel data types.

- Full cell formatting support.

- Formula support, including new Excel 365 dynamic functions.

- Charts.

- Hyperlink support.

- Page/Printing Setup support.

- Merged ranges.

- Conditional formatting.

- Data validation.

- Cell Notes.

- Textboxes.

- Sparklines.

- Worksheet PNG/JPEG/GIF/BMP images.

- Rich multi-format strings.

- Defined names.

- Autofilters.

- Worksheet Tables.

- Serde serialization support.

- Support for macros.

- Memory optimization mode for writing large files.



`rust_xlsxwriter` is under active development and new features will be added

frequently.



[`XlsxWriter`]: https://xlsxwriter.readthedocs.io/index.html

[rust_xlsxwriter GitHub]: https://github.com/jmcnamara/rust_xlsxwriter



## Features



- `default`: Includes all the standard functionality. This has a dependency on

  the `zip` crate only.



- `constant_memory`: This keeps memory usage to a minimum when writing

  writing large files.



- `serde`: Adds supports for Serde serialization. This is off by default.



- `chrono`: Adds supports for Chrono date/time types to the API. This is off by

  default.



- `zlib`: Adds a dependency on `zlib` and a C compiler. This includes the same

  features as `default` but is 1.5x faster for large files.



- `polars`: Add support for mapping between `PolarsError` and

  `rust_xlsxwriter::XlsxError` to make code that handles both types of error

  easier to write.



- `wasm`: Adds a dependency on `js-sys` and `wasm-bindgen` to allow compilation

  for wasm/JavaScript targets.



- `ryu`: Adds a dependency on `ryu`. This speeds up writing numeric

  worksheet cells for large data files. It gives a performance boost above

  300,000 numeric cells and can be up to 30% faster than the default number

  formatting for 5,000,000 numeric cells.



## Release notes



Recent changes:



- Added `constant_memory` mode.

- Removed requirement on `regex` crate.



See the full [Release Notes and Changelog].



## See also



- [User Guide]: Working with the `rust_xlsxwriter` library.

    - [Getting started]: A simple getting started guide on how to use

      `rust_xlsxwriter` in a project and write a Hello World example.

    - [Tutorial]: A larger example of using `rust_xlsxwriter` to write some

       expense data to a spreadsheet.

    - [Cookbook].

- [The rust_xlsxwriter crate].

- [The rust_xlsxwriter API docs at docs.rs].

- [The rust_xlsxwriter repository].

- [Roadmap of planned features].



[User Guide]: https://rustxlsxwriter.github.io/index.html

[Getting started]: https://rustxlsxwriter.github.io/getting_started.html

[Tutorial]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/tutorial/index.html

[Cookbook]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/cookbook/index.html



[The rust_xlsxwriter crate]: https://crates.io/crates/rust_xlsxwriter

[The rust_xlsxwriter API docs at docs.rs]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/

[The rust_xlsxwriter repository]: https://github.com/jmcnamara/rust_xlsxwriter

[Release Notes and Changelog]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/changelog/index.html

[Roadmap of planned features]: https://github.com/jmcnamara/rust_xlsxwriter/issues/1