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

63
parser/CHANGELOG.md
View file

@ -1,29 +1,34 @@
# Changelog # Changelog
## Upcoming ## Upcoming
### Breaking changes
- The `encoding` library has been replaced with `encoding_rs`. If you use the **Breaking Changes**:
`trap` of `YamlDecoder`, this change will make your code not compile.
An additional enum `YamlDecoderTrap` has been added to abstract the - The `encoding` library has been replaced with `encoding_rs`. If you use the
underlying library and avoid breaking changes in the future. This `trap` of `YamlDecoder`, this change will make your code not compile.
additionally lifts the `encoding` dependency on _your_ project if you were An additional enum `YamlDecoderTrap` has been added to abstract the
using that feature. underlying library and avoid breaking changes in the future. This
- The `encoding::types::DecoderTrap` has been replaced with `YamlDecoderTrap`. additionally lifts the `encoding` dependency on _your_ project if you were
- The signature of the function for `YamlDecoderTrap::Call` has changed: using that feature.
```rs - The signature of the function for `YamlDecoderTrap::Call` has changed:
// Before, with `encoding::types::DecoderTrap::Call` - The `encoding::types::DecoderTrap` has been replaced with `YamlDecoderTrap`.
fn(_: &mut encoding::RawDecoder, _: &[u8], _: &mut encoding::StringWriter) -> bool; ```rust
// Now, with `YamlDecoderTrap::Call` // Before, with `encoding::types::DecoderTrap::Call`
fn(_: u8, _: u8, _: &[u8], _: &mut String) -> ControlFlow<Cow<'static str>>; fn(_: &mut encoding::RawDecoder, _: &[u8], _: &mut encoding::StringWriter) -> bool;
``` // Now, with `YamlDecoderTrap::Call`
Please refer to the `YamlDecoderTrapFn` documentation for more details. fn(_: u8, _: u8, _: &[u8], _: &mut String) -> ControlFlow<Cow<'static str>>;
```
Please refer to the `YamlDecoderTrapFn` documentation for more details.
**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**:
@ -32,30 +37,30 @@
**Features**: **Features**:
- Multi-line strings are now - Multi-line strings are now
[emitted using block scalars](https://github.com/chyh1990/yaml-rust/pull/136). [emitted using block scalars](https://github.com/chyh1990/yaml-rust/pull/136).
- Error messages now contain a byte offset to aid debugging. - Error messages now contain a byte offset to aid debugging.
([#176](https://github.com/chyh1990/yaml-rust/pull/176)) ([#176](https://github.com/chyh1990/yaml-rust/pull/176))
- Yaml now has `or` and `borrowed_or` methods. - Yaml now has `or` and `borrowed_or` methods.
([#179](https://github.com/chyh1990/yaml-rust/pull/179)) ([#179](https://github.com/chyh1990/yaml-rust/pull/179))
- `Yaml::load_from_bytes()` is now available. - `Yaml::load_from_bytes()` is now available.
([#156](https://github.com/chyh1990/yaml-rust/pull/156)) ([#156](https://github.com/chyh1990/yaml-rust/pull/156))
- The parser and scanner now return Err() instead of calling panic. - The parser and scanner now return Err() instead of calling panic.
**Development**: **Development**:
- The documentation was updated to include a security note mentioning that - The documentation was updated to include a security note mentioning that
yaml-rust is safe because it does not interpret types. yaml-rust is safe because it does not interpret types.
([#195](https://github.com/chyh1990/yaml-rust/pull/195)) ([#195](https://github.com/chyh1990/yaml-rust/pull/195))
- Updated to quickcheck 1.0. - Updated to quickcheck 1.0.
([#188](https://github.com/chyh1990/yaml-rust/pull/188)) ([#188](https://github.com/chyh1990/yaml-rust/pull/188))
- `hashlink` is [now used](https://github.com/chyh1990/yaml-rust/pull/157) - `hashlink` is [now used](https://github.com/chyh1990/yaml-rust/pull/157)
instead of `linked_hash_map`. instead of `linked_hash_map`.
## v0.6.0 ## v0.6.0
@ -70,7 +75,7 @@
## v0.5.0 ## v0.5.0
- The parser now supports tag directives. - The parser now supports tag directives.
([#35](https://github.com/chyh1990/yaml-rust/issues/35) ([#35](https://github.com/chyh1990/yaml-rust/issues/35)
- The `info` field has been exposed via a new `Yaml::info()` API method. - The `info` field has been exposed via a new `Yaml::info()` API method.
([#190](https://github.com/chyh1990/yaml-rust/pull/190)) ([#190](https://github.com/chyh1990/yaml-rust/pull/190))