Rustpy-xlsxwriter

Added

- Added support for embedding images into worksheets with
[`worksheet::embed_image()`] and [`worksheet::embed_image_with_format()`] and
the [`Image`] struct. See the [Embedded Images] example.

This can be useful if you are building up a spreadsheet of products with a
column of images for each product. Embedded images move with the cell so they
can be used in worksheet tables or data ranges that will be sorted or
filtered.

This functionality is the equivalent of Excel's menu option to insert an image
using the option to "Place in Cell" which is available in Excel 365 versions
from 2023 onwards.

[`worksheet::embed_image()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.embed_image
[`worksheet::embed_image_with_format()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.embed_image_with_format

[Embedded Images]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/cookbook/index.html#insert-images-embedding-an-image-in-a-cell


- Updated `polars` dependency to 0.37.2 to pick up latest Polars additions for
[`polars_excel_writer`].


- Added [`utility::check_sheet_name()`] function to allow checking for valid
worksheet names according to Excel's naming rules. This functionality was
previously `pub(crate)` private.

[Feature Request 83].

[Feature Request 83]: https://github.com/jmcnamara/rust_xlsxwriter/issues/83

[`utility::check_sheet_name()`]:
https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/utility/fn.check_sheet_name.html

Removed

- Removed unnecessary lifetime on [`Format`] objects used in Worksheet `write()`
methods. This allows the the [`IntoExcelData`] trait to be defined for user
types and have them include a default format. See [Feature Request 85].

[Feature Request 85]: https://github.com/jmcnamara/rust_xlsxwriter/issues/85
[`Format`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/struct.Format.html

Added

- Added support for adding a worksheet [`Table`] as a serialization format. See [`SerializeFieldOptions::set_table()`].

- Added [`Worksheet::get_serialize_dimensions()`] and
[`Worksheet::get_serialize_column_dimensions()`] methods to get dimensions
from a serialized range.

- Updated `polars` dependency to 0.36.2 to pick up Polars `AnyData` changes for
[`polars_excel_writer`].


[`Worksheet::get_serialize_dimensions()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.get_serialize_dimensions

[`Worksheet::get_serialize_column_dimensions()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/worksheet/struct.Worksheet.html#method.get_serialize_column_dimensions


[`SerializeFieldOptions::set_table()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/serializer/struct.SerializeFieldOptions.html#method.set_table


Changed

- Changed APIs for [`Table`] to return `Table` instead of `&Table` to allow
methods to be chained. This makes worksheet Table usage easier during
serialization. Note that this is a backward incompatible change.

Added

- Added support for a `XlsxSerialize` derive and struct attributes to control
the formatting and options of the Excel output during serialization. These are
similar in intention to Serde container/field attributes.

See [Controlling Excel output via `XlsxSerialize` and struct attributes] and
[Working with Serde].

[Feature Request 66].

[Feature Request 66]: https://github.com/jmcnamara/rust_xlsxwriter/issues/66

[Controlling Excel output via `XlsxSerialize` and struct attributes]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/serializer/index.html#controlling-excel-output-via-xlsxserialize-and-struct-attributes


- Added `XlsxError::CustomError` as a target error for external crates/apps.

[Feature Request 72].

[Feature Request 72]: https://github.com/jmcnamara/rust_xlsxwriter/issues/72

Added

- Added support for setting Serde headers using deserialization of a target
struct type as well as the previous method of using serialization and an
instance of the struct type. See [Setting serialization headers].

[Feature Request 63].

- Added additional support for serialization header and field options via
[`CustomSerializeField`].

- Added support for writing `Result<T, E>` with [`Worksheet::write()`] when `T`
and `E` are supported types.

[Feature Request 64].

[Feature Request 63]: https://github.com/jmcnamara/rust_xlsxwriter/issues/63
[Feature Request 64]: https://github.com/jmcnamara/rust_xlsxwriter/issues/64
[Setting serialization headers]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/serializer/index.html#setting-serialization-headers
[`CustomSerializeField`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/serializer/struct.CustomSerializeField.html

Added

- Added [`serialize_chrono_option_naive_to_excel()`] to help serialization of
`Option` Chrono types. [Feature Request 62].

[Feature Request 62]: https://github.com/jmcnamara/rust_xlsxwriter/issues/62

[`serialize_chrono_option_naive_to_excel()`]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/utility/fn.serialize_chrono_option_naive_to_excel.html

Added

- Added serialization support for [`ExcelDateTime`] and [`Chrono`] date/time
types. See [Working with Serde - Serializing dates and times].

[Working with Serde - Serializing dates and times]: https://docs.rs/rust_xlsxwriter/latest/rust_xlsxwriter/serializer/index.html#serializing-dates-and-times