arcayr/saphyr-serde
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

CHANGELOG: simplify the formatting and document YamlLoader::documents()

Browse source
This commit is contained in:
David Aguilar 2024-03-24 14:44:09 -07:00
parent 06708ee787
commit 86f008196c
1 changed files with 34 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
parser/CHANGELOG.md
View file

@ -1,16 +1,18 @@
# Changelog # Changelog
## Upcoming ## Upcoming
### Breaking changes
**Breaking Changes**:
- The `encoding` library has been replaced with `encoding_rs`. If you use the - The `encoding` library has been replaced with `encoding_rs`. If you use the
`trap` of `YamlDecoder`, this change will make your code not compile. `trap` of `YamlDecoder`, this change will make your code not compile.
An additional enum `YamlDecoderTrap` has been added to abstract the An additional enum `YamlDecoderTrap` has been added to abstract the
underlying library and avoid breaking changes in the future. This underlying library and avoid breaking changes in the future. This
additionally lifts the `encoding` dependency on _your_ project if you were additionally lifts the `encoding` dependency on _your_ project if you were
using that feature. using that feature.
- The `encoding::types::DecoderTrap` has been replaced with `YamlDecoderTrap`.
- The signature of the function for `YamlDecoderTrap::Call` has changed: - The signature of the function for `YamlDecoderTrap::Call` has changed:
```rs - The `encoding::types::DecoderTrap` has been replaced with `YamlDecoderTrap`.
```rust
// Before, with `encoding::types::DecoderTrap::Call` // Before, with `encoding::types::DecoderTrap::Call`
fn(_: &mut encoding::RawDecoder, _: &[u8], _: &mut encoding::StringWriter) -> bool; fn(_: &mut encoding::RawDecoder, _: &[u8], _: &mut encoding::StringWriter) -> bool;
// Now, with `YamlDecoderTrap::Call` // Now, with `YamlDecoderTrap::Call`
@ -21,10 +23,13 @@
**Features**: **Features**:
- Tags can now be retained across documents by calling `keep_tags(true)` on a - Tags can now be retained across documents by calling `keep_tags(true)` on a
`yaml_rust2::Parser` before loading documents. `Parser` before loading documents.
([#10](https://github.com/Ethiraric/yaml-rust2/issues/10) ([#10](https://github.com/Ethiraric/yaml-rust2/issues/10)
([#12](https://github.com/Ethiraric/yaml-rust2/pull/12)) ([#12](https://github.com/Ethiraric/yaml-rust2/pull/12))
- `YamlLoader` structs now have a `documents()` method that returns the parsed
documents associated with a loader.
**Development**: **Development**:
## v0.7.0 ## v0.7.0