toml

Features

• (serde) Support char, bool, and integers as keys

Compatibility

• Update MSRV to 1.76

Internal

• Update dependencies

Performance

• Allow more build parallelism by depending on serde_core

Fixes

• Improve missing-open-quote errors
• Don't treat trailing quotes as separate items
• Conjoin more values in unquoted string errors
• Reduce float false positives
• Reduce float/bool false positives

Features

• Add DeInteger::as_str and DeInteger::radix for converting to desired integer types
• Add DeFloat::as_str for converting to desired floating-point types

Fixes

• (display) Only enable toml_writer/std if std is enabled

Fixes

• Fix infinite loop when ) is present outside of quotes

Migration

1. If you set default-features = false, run cargo add toml -F serde,std
2. Resolve errors as you come across them

Compatibility

Breaking Changes

• from_str, Deserializer, etc no longer preserve order, requiring the preserve_order feature like Table
• Serde support has been broken out into the default serde feature
• Std support has been broken out into the default std feature
• Fail quickly when deserializing a value without a Spanned
• impl FromStr for Value now parses TOML values, not documents
• Deserializer::new / ValueDeserializer::new now return errors
• Serializer::new and Serializer::pretty now take a &mut Buffer, rather than a &mut String
• <Serializer<'d> as serde::ser::Serializer>::Ok is now &'d mut Buffer
• <ValueSerializer<'d> as serde::ser::Serializer>::Ok is now &'d mut String

Other

• New TOML parser and writer which carries a risk for regressions
• Deprecated Deserializer::new / ValueDeserializer::new in favor of Deserializer::parse / ValueDeserializer::parse

Performance

• Added fast_hash feature

Features

• Add Spanned<DeTable<'input>> as a serde-less, zero-copy, span tracking format to parse to, with error recovery
• Add de::from_slice
• Add Table::remove_entry
• debug feature for easier debugging
• Added From and IntoDeserializer impls for Deserializer / ValueDeserializer
• Added big-integer, big-float, u64, u128, and i128 support to serde and DeValue (but not Value)

Fixes

• impl FromStr for Value now parses TOML values, not documents

Fixes

• (serde) Serialize struct variants
• (serde) Serialize tuple variants under their variant name

Fixes

• (serde) Skip key-value pairs where the value is a newtype wrapping None

Features

• Add unbounded feature to bypass recursion depth checks

Fixes

• Reduced escaping in strings without a prior formatting

Compatibility

• Serializing a Table no longer has a specific sub-table order
• Strings have changed formats
  • A trailing single quote no longer prevents "pretty" strings
  • Double quotes in ml-basic-strings are only escaped if there are 3 or more
  • Presence of 1-2 double quotes and newlines no longer forces the use of ml-literal instead ml-basic-string

Features

• Add Map::get_key_value

Performance

• Fix regression in 0.22.19

Fixes

• Prevent a stack overflow when parsing very large files

Performance

• Speed up whitespace parsing
• Speed up empty array parsing
• Speed up general array parsing
• Speed up general value parsing

Features

• impl Serialize/Deserialize for Date/Time

Fixes

• When recursion depth is reached, be sure to show that error rather than something else

Fixes

• Correctly encode TOML keys with mixed quotes

Fixes

• Allow inferring keys as string literals
• Prefer string literals if it avoids escaping double-quotes

Fixes

• Drop recursion limit from 128 to 100 to work on opt-level = 0 builds

Performance

• (de) Remove an allocation when parsing

Compatibility

MSRV is now 1.70

Internal

• Update toml_edit dependency

Fixes

• (de) Improve error span for empty tables

Compatibility

MSRV is now 1.69

Compatibility

• If you relied on toml to enable toml_edit parse or display features, it will no longer work

Fixes

• (ser) Make sign of nan deterministic by always being positive

Fixes

• (parser) Ensure the sign of NAN is preserved
• (serde) Ensure the sign of NAN is preserved

Fixes

• (parser) Error on invalid days of month, accounting for leap years

Compatibility

MSRV is now 1.67

Fixes

• (parser) Correctly error when mixing inline tables with inline dotted keys

Fixes

• (de) Allow parsing keys into newtypes

Compatibility

• Serialization and deserialization of tuple variants has changed from being an array to being a table with the key being the variant name and the value being the array

Fixes

• Consistently serialize and deserialize struct and tuple variants, matching serde_json's behavior

Fixes

• (ser) Don't lose data when inline tables are nested deeply under arrays

Fixes

• (ser) Error rather than drop whole arrays when a single element is None

Compatibility

MSRV is now 1.66.0

Features

• Add Map::retain

Internal

• Update indexmap

Features

• (ser) Newtype variant support

Compatibility

MSRV is now 1.64.0

Fixes

• Don't skip writing standard tables that are "underneath" dotted keys

Fixes

• (ser) Error on i64 overflow

Documentation

• Show features on doc.rs

Breaking Change

• Offset::Custom changed from tracking hours+minutes to minutes
• Offset::Customs parser now enforces a range of minutes
• Removed deprecated Error::line_col infavor of Error::span
• Removed deprecated ser::tables_last as it isn't needed anymore
• Removed deprecagted Serializer::pretty_* functions as toml_edit is for greater customization

Fixes

• Allow negative minute Offsets

Compatibility

Breaking Behavior Changes

• FromStr impl for Value now only parses toml values, not documents. See instead Table
• Display impl for Value now only renders toml values, not documents. See instead Table
• from_str now only parses toml documents, not values. See instead de::ValueDeserializer
• to_string / to_string_pretty now only renders toml documents, not values. See instead ser::ValueSerializer

Breaking API Changes

• de::from_slice and ser::to_vec were removed, instead use from_str and to_string and convert with bytes manually
• toml! returns a Table, rather than a Value
• toml::de can no longer deserialize to borrowed types as everything becomes owned through the parsing process
• serde::de::Deserializer is now implemented for toml::Deserializer, rather than &mut toml::Deserializer
• serde::ser::Serializer is now implemented for toml::Serializer, rather than &mut toml::Serializer
• value no longer re-exports Map and Entry
• Spanned::spans return type changed to std::ops::Range<usize>
• Spanned::start removed in favor of Spanned::span().start
• Spanned::wnd removed in favor of Spanned::span().end
• parse and display default features were added
• toml::ser::Errors variants are private. For toml::ser::Error::Custom, you can use serde::ser::Error::custom
• Deprecated items from 0.5 were removed

Deprecations

• Deprecated Deserializer::tables_last, it is no longer needed
• Deprecated Deserializer::pretty_string, this is all bundled up with pretty
• Deprecated Deserializer::pretty_string_literal, this is all bundled up with pretty
• Deprecated Deserializer::pretty_array, this is all bundled up with pretty
• Deprecated Deserializer::pretty_array_indent, this is all bundled up with pretty
• Deprecated Deserializer::pretty_array_trailing_comma, this is all bundled up with pretty
• Deprecated de::Error::line_col, replaced with de::Error::span

MSRV is now 1.60.0

Features

• Table now impls Display, FromStr, Deserialize
• Table now has try_from and try_into methods
• Added de::ValueDeserializer and ser::ValueSerializer for exclusively working with toml values
• Provide de::Error::span and de::Error::message, allowing custom error rendering

Fixes

• Bring the parser into full TOML 1.0 compliance
• (parse) Improve the quality of spans in Spanned / errors
• (display) Automatically handle root key-value pairs vs tables, removing the need for tables_last
• (display) Fix problems with stray , being inserted when using array of tables
• (error) Show the error locatation in the source for parse and deserialize errors