Skip to content

Commit

Permalink
CHANGELOG update
Browse files Browse the repository at this point in the history
  • Loading branch information
danielaparker committed Dec 31, 2024
1 parent 894281b commit 853219a
Showing 1 changed file with 35 additions and 22 deletions.
57 changes: 35 additions & 22 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,41 @@

- API Changes

- Non-const `basic_json::operator[const string_view_type& key]` no longer returns a proxy type. The rationale for this change is given in Git Issue #315.
The new behavior for the non-const overload of `operator[](const string_view_type& key)` is to return a reference to the value that is associated with `key`, inserting a default
constructed value with the key if no such key already exists, which is consistent with the standard library
`std::map` behavior. The new behavior for the const overload of `operator[](const string_view_type& key)` is to return
a const reference to the value that is associated with `key`, returning a const reference to a default
constructed value with static storage duration if no such key already exists.

- Until 1.0.0, a buffer of text is supplied to `basic_json_parser` with a call to `update()`
followed by a call to `parse_some()`. Once the parser reaches the end of the buffer,
additional JSON text can be supplied to the parser with another call to `update()`,
followed by another call to `parse_some()`. See [Incremental parsing (until 1.0.0)](https://github.com/danielaparker/jsoncons/blob/master/doc/ref/corelib/basic_json_parser.md#incremental-parsing-until-01790).
Since 0.179, an initial buffer of text is supplied to the parse with a call to
`set_buffer`, and parsing commences with a call to `parse_some`. The parser can be
constructed with a user provided chunk reader to obtain additional JSON text
as needed. See [Incremental parsing (since 1.0.0)](https://github.com/danielaparker/jsoncons/blob/master/doc/ref/corelib/basic_json_parser.md#incremental-parsing-since-01790).

- enum `bigint_chars_format` is deprecated and replaced by `bignum_format_kind`. Added `bignum_format` getter and setter functions to `basic_json_options`,
and deprecated `bigint_format` getter and setter functions. Changed default `bignum_format` from `bigint_chars_format::base10`
to `bignum_format_kind::raw`. Rationale: `bigint_chars_format` was misnamed, as it applied to `bigdec` as well as `bigint` numbers, and
defaulting to `bigint_chars_format::base10` produced surprising results for users of our lossless number option.

- The URI argument passed to the jsonschema ResolveURI function object now included the fragment part of the URI.
- Non-const `basic_json::operator[const string_view_type& key]` no longer
returns a proxy type. The rationale for this change is given in Git Issue
#315. The new behavior for the non-const overload of `operator[](const
string_view_type& key)` is to return a reference to the value that is
associated with `key`, inserting a default constructed value with the key
if no such key already exists, which is consistent with the standard
library `std::map` behavior. The new behavior for the const overload of
`operator[](const string_view_type& key)` is to return a const reference
to the value that is associated with `key`, returning a const reference to
a default constructed value with static storage duration if no such key
already exists.

- Until 1.0.0, a buffer of text is supplied to `basic_json_parser` with a
call to `update()` followed by a call to `parse_some()`. Once the parser
reaches the end of the buffer, additional JSON text can be supplied to the
parser with another call to `update()`, followed by another call to
`parse_some()`. See [Incremental parsing (until
1.0.0)](https://github.com/danielaparker/jsoncons/blob/master/doc/ref/corelib/basic_json_parser.md#incremental-parsing-until-01790).
Since 0.179, an initial buffer of text is supplied to the parse with a
call to `set_buffer`, and parsing commences with a call to `parse_some`.
The parser can be constructed with a user provided chunk reader to obtain
additional JSON text as needed. See [Incremental parsing (since
1.0.0)](https://github.com/danielaparker/jsoncons/blob/master/doc/ref/corelib/basic_json_parser.md#incremental-parsing-since-01790).

- enum `bigint_chars_format` is deprecated and replaced by
`bignum_format_kind`. Added `bignum_format` getter and setter functions
to `basic_json_options`, and deprecated `bigint_format` getter and setter
functions. Changed default `bignum_format` from
`bigint_chars_format::base10` to `bignum_format_kind::raw`. Rationale:
`bigint_chars_format` was misnamed, as it applied to `bigdec` as well as
`bigint` numbers, and defaulting to `bigint_chars_format::base10` produced
surprising results for users of our lossless number option.

- The URI argument passed to the jsonschema ResolveURI function object now
included the fragment part of the URI.

- Fixed bugs:

Expand Down

0 comments on commit 853219a

Please sign in to comment.