mongodb/bson-rust
### [`v2.4.0`](https://togithub.com/mongodb/bson-rust/releases/tag/v2.4.0)
[Compare Source](https://togithub.com/mongodb/bson-rust/compare/v2.3.0...v2.4.0)
### Description
The MongoDB Rust driver team is pleased to announce the v2.4.0 release of the `bson` crate.
### Highlighted Changes
The following sections detail some of the more important changes included in this release. For a full list of changes, see the [Full Release Notes](#full-release-notes) section below.
#### Support for 1.x of the `uuid` crate
The `bson` crate now has a `uuid-1` feature that provides an API for interoperation with versions 1.x of the `uuid` crate, similar to the existing `uuid-0_8` feature. Internal usage of `uuid` now uses 1.x, so downstream crates without a need for 0.8 will no longer transitively depend on both version.
#### Builder for `DateTime` values
The `DateTime` type now provides a builder that allows convenient construction from a given `year`, `month`, `day`, and optionally, an `hour`, `minute`, `second` and `millisecond`.
### Full Release Notes
#### New Features
- RUST-1305 Add support for version 1.x of the uuid crate to the bson crate
- RUST-1198 Support creating bson::DateTime from a given year/month/date/hour/minute/second/millisecond
#### Tasks
- RUST-1398 Pin `clippy` version to 1.62.0
- RUST-1374 Pin all dependencies when checking MSRV compilation
### [`v2.3.0`](https://togithub.com/mongodb/bson-rust/releases/tag/v2.3.0)
[Compare Source](https://togithub.com/mongodb/bson-rust/compare/v2.2.0...v2.3.0)
### Description
The MongoDB Rust driver team is pleased to announce the `2.3.0` release of the `bson` crate. This release increases the crate's MSRV to 1.53 and makes the crate's dependency on `chrono` optional.
### Full Release Notes
#### Task
- RUST-1263 Bump MSRV to 1.53 ([#352](https://togithub.com/mongodb/bson-rust/issues/352))
#### Improvement
- RUST-1129 Replace `chrono` dependency with `time` ([#352](https://togithub.com/mongodb/bson-rust/issues/352))
### [`v2.2.0`](https://togithub.com/mongodb/bson-rust/releases/tag/v2.2.0)
[Compare Source](https://togithub.com/mongodb/bson-rust/compare/v2.1.0...v2.2.0)
### Description
The MongoDB Rust driver team is pleased to announce the v2.2.0 release of the `bson` crate.
### Highlighted Changes
The following sections detail some of the more important changes included in this release. For a full list of changes, see the [Full Release Notes](#full-release-notes) section below.
#### Raw BSON (RUST-284, RUST-1045, RUST-1082, RUST-1109, RUST-1111, RUST-1119)
Both of the existing ways of working with BSON values (the `BSON` type or using Serde) require parsing the values up-front. This can be a performance bottleneck in certain circumstances; to address this, we've introduced the `RawBson`, `RawDocument`, and `RawArray` types.
These types provide an interface similar to the existing BSON types, but are backed by a buffer of BSON bytes rather than a fully parsed `enum` or hash map. This enables zero-copy reads with minimal parsing and highly memory-efficient manipulation.
In tradeoff, these types do not provide the full set of operations that the standard ones can, and the performance of element access is O(N) rather than then average O(1) of the parsed types.
Thanks to [@jcdyer](https://togithub.com/jcdyer) for contributing the initial implementation!
### Full Release Notes
#### New Features
- RUST-284 Incorporate raw BSON code from rawbson = "0.2.1" in mod raw ([#229](https://togithub.com/mongodb/bson-rust/issues/229))
- RUST-1045 Support appending to RawDocumentBuf ([#326](https://togithub.com/mongodb/bson-rust/issues/326))
- RUST-1109 Implement rawbson! and rawdoc! macros ([#329](https://togithub.com/mongodb/bson-rust/issues/329))
- RUST-1119 Add bson::to_raw_document_buf function ([#330](https://togithub.com/mongodb/bson-rust/issues/330))
- RUST-1111 Support deserializing RawBson from Bson ([#331](https://togithub.com/mongodb/bson-rust/issues/331))
- minor: raw BSON perf and API improvements ([#335](https://togithub.com/mongodb/bson-rust/issues/335))
#### Bugfixes
- RUST-1243 Handle enum keys when deserializing a map from binary ([#348](https://togithub.com/mongodb/bson-rust/issues/348)) (thanks [@George-Miao](https://togithub.com/George-Miao)!)
- RUST-1240 Fix potential underflow in length counting ([#349](https://togithub.com/mongodb/bson-rust/issues/349))
- RUST-1195 Add missing trait impls to Uuid ([#345](https://togithub.com/mongodb/bson-rust/issues/345))
### [`v2.1.0`](https://togithub.com/mongodb/bson-rust/releases/tag/v2.1.0)
[Compare Source](https://togithub.com/mongodb/bson-rust/compare/v2.0.1...v2.1.0)
### Description
The MongoDB Rust driver team is pleased to announce the `v2.1.0` release of the `bson` crate.
### Highlighted changes
The following sections detail some of the more important changes included in this release. For a full list of changes, see the [Full Release Notes](#full-release-notes) section below.
#### Better `Uuid` ergonomics (RUST-819, RUST-465, RUST-1024)
Working with UUIDs in BSON is a bit of a pain point, since the widely used `Uuid` type from the `uuid` crate doesn't serialize to or from BSON UUIDs (i.e. Binary with subtype 4) out of the box. To address this, we introduced a `bson::Uuid` type, which serializes as a BSON UUID when using `bson::to_bson` or `bson::to_slice` and uses `uuid::Uuid`'s `Serialize` implementation for other formats.
Additionally, we implemented the UUID [driver specification](https://togithub.com/mongodb/specifications/blob/master/source/uuid.rst), which enables easy conversion between `Binary` and `bson::Uuid`. It also adds support for handling BSON UUIDs that may have been serialized using the legacy format from one of the other MongoDB drivers (Python, Java, or C#).
Lastly, we introduced support for using the [`serde_with`](https://docs.rs/serde_with/1.11.0/serde_with/) crate to serialize `uuid::Uuid`s to BSON. This requires the usage of the `serde_with` and `uuid-0_8` feature flags. See the next section for more details.
#### `serde_with` integration (RUST-1024)
As mentioned in the previous section, we've added optional support for the [`serde_with`](https://docs.rs/serde_with/1.11.0/serde_with/) crate via the `serde_with` feature flag. Right now, this allows for serialization of `chrono::DateTime` as `bson::DateTime` (with the `chrono-0_4` feature flag) and `uuid::Uuid` as `bson::Uuid` (with the `uuid-0_8` feature flag). The main improvement of `serde_with` annotations over the existing serde helpers is that they also work when the `Uuid` or `DateTime` type is nested, such as in an `Option`.
```rust
#[serde_with::serde_as]
#[derive(Serialize, Deserialize, Debug)]
struct MyData {
#[serde_as(as = "Option")]
uuid: Option,
#[serde_as(as = "Option")]
dt: Option>,
}
let val = MyData {
uuid: Some(uuid::Uuid::new_v4()),
dt: chrono::Utc::now().into(),
};
// prints { "uuid": Binary(0x4, mMKbFkXEQMeLnfSNY+/NMg==), "dt": DateTime("2021-11-12 21:14:15.385 UTC") }
println!("{}", bson::to_bson(&val)?);
```
#### Support configuring `Serializer` and `Deserializer` to be not human-readable (RUST-1022)
`Serializer` and `Deserializer`, which are used in `bson::(to|from)_(bson|document)`, have never implemented the `is_human_readable` requirement from their respective `serde` traits, meaning they default to true. The raw serializer and deserializer, which are used in `bson::to_vec` and `bson::from_slice`, do report as non-human readable though. The unfortunate result of this inconsistency is that types that change their serialized format depending on whether the (de)serializer is human readable or not may produce different BSON depending on whether `to_bson` or `to_vec` are used. To help address this issue, this release includes support for configuring `Serializer` and `Deserializer` to report themselves as not human readable.
```rust
#[derive(Debug, Deserialize, Serialize)]
struct MyData {
a: String,
}
let data = MyData { a: "ok".to_string() };
let options = SerializerOptions::builder().human_readable(false).build();
let bson = bson::to_bson_with_options(&data, options)?;
let options = DeserializerOptions::builder().human_readable(false).build();
let rt_data: MyData = bson::from_bson_with_options(bson, options)?;
```
### Full Release Notes
#### New Features
- RUST-465 Create a UUID wrapper type for serialization to / deserialization from BSON binary ([#314](https://togithub.com/mongodb/bson-rust/issues/314))
- RUST-977 Support parsing bson::DateTime from RFC 3339 formatting string even without chrono feature flag ([#317](https://togithub.com/mongodb/bson-rust/issues/317))
- RUST-1022 Introduce way to serialize to / deserialize from Bson with is_human_readable = false ([#321](https://togithub.com/mongodb/bson-rust/issues/321))
- RUST-1024 Add `serde_with` integration for composable serde helpers ([#323](https://togithub.com/mongodb/bson-rust/issues/323))
- RUST-787 Implement `Display` for all BSON types ([#305](https://togithub.com/mongodb/bson-rust/issues/305))
- RUST-966 Add BSON Binary subtype 7 ([#315](https://togithub.com/mongodb/bson-rust/issues/315))
#### Improvements
- Remove `time` transitive dependency and `clock` feature flag from `chrono` ([#316](https://togithub.com/mongodb/bson-rust/issues/316))
- Thanks [@roccodev](https://togithub.com/roccodev)!
#### Bugfixes
- RUST-1107 Fix array relaxed extended JSON ([#325](https://togithub.com/mongodb/bson-rust/issues/325)) (thanks [@pacifistes](https://togithub.com/pacifistes)!)
### [`v2.0.1`](https://togithub.com/mongodb/bson-rust/compare/v2.0.0...v2.0.1)
[Compare Source](https://togithub.com/mongodb/bson-rust/compare/v2.0.0...v2.0.1)
### [`v2.0.0`](https://togithub.com/mongodb/bson-rust/releases/tag/v2.0.0)
[Compare Source](https://togithub.com/mongodb/bson-rust/compare/v1.2.4...v2.0.0)
### Description
The MongoDB Rust driver team is pleased to announce the `v2.0.0` release of the `bson` crate. This release is the culmination of several months of work, and it contains a number of new features, API improvements, and bug fixes. This release will be included in `v2.0.0` of the driver. It is intended that this release will be very stable and that `bson` will not have another major release for quite a long time.
Note that the new minimum supported Rust version (MSRV) is now 1.48.0.
### Highlighted changes
The following sections detail some of the more important changes included in this release. For a full list of changes, see the [Full Release Notes](#full-release-notes) section below.
#### Ensure API meets the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/checklist.html) (RUST-765)
There is a community maintained list of API guidelines that every stable Rust library is recommended to meet. The crate's existing API wasn't conforming to these guidelines exactly, so a number of improvements were made to ensure that it does. Here we highlight a few of the more important changes made in this effort.
##### Stabilize or eliminate public dependencies on unstable crates ([C-STABLE](https://rust-lang.github.io/api-guidelines/necessities.html#c-stable), RUST-739)
`bson` included types from a number of unstable (pre-1.0) dependencies in its public API, which presented a problem for the stability of the library itself. In an effort to ensure that `bson` will no longer be subject to the semver breaks of unstable dependencies and can stay on 2.0 for the foreseeable future, the public dependencies on unstable types were removed altogether or gated behind feature flags.
Here are the notable changes made as part of that:
- `Bson::DateTime(chrono::DateTime)` => `Bson::DateTime(bson::DateTime)`, `struct Datetime(pub chrono::DateTime)` => `struct DateTime { /* private fields */ }`
- Instead of directly including a `DateTime` from `chrono` (which is currently `0.4`) in the `Bson` enum, the variant now wraps the `bson::DateTime` newtype defined within `bson`, and that newtype also no longer wraps a `chrono::DateTime`. This way the dependency on `chrono` can be updated to new semver breaking versions without having to update `bson`'s major version.
- To ease in the construction and usage of the newtype from `chrono::DateTime`, the `chrono-0_4` feature flag can be enabled, which includes a `From` implementation for `bson::DateTime` and a `From` implementation for `chrono::DateTime`, as well as some serde helpers.
- `Document::get_datetime` returns a `ValueAccessResult` of `&bson::DateTime` instead of `&chrono::DateTime`
- `Bson::as_datetime` returns an `Option` of `&bson::DateTime` instead of `&chrono::DateTime`
- `ObjectId::timestamp` returns a `crate::DateTime` instead of `chrono::DateTime`
- `oid::Error` no longer wraps `hex::FromHexError` (the `hex` crate is `0.4`), see [below](#error-naming-improvements-c-word-order-c-stable) for details.
- The `Uuid` serde helpers, as well as `From` implementations for `Bson` and `Binary`, are now gated behind the `uuid-0_8` feature flag.
##### Accept `impl AsRef` in `Document` methods ([C-GENERIC](https://rust-lang.github.io/api-guidelines/flexibility.html#c-generic), RUST-765)
The methods on `Document` that accepted keys previously accepted them as `&str`. They were updated to accept `impl AsRef` instead to allow other string-like types to be used for key lookup, such as `String`.
##### Use more standard conversion constructors for `ObjectId` ([C-CONV-TRAITS](https://rust-lang.github.io/api-guidelines/interoperability.html#c-conv-traits), [C-CTOR](https://rust-lang.github.io/api-guidelines/predictability.html#c-ctor), RUST-789)
ObjectId previously had three constructors: `new`, `with_bytes`, and `with_string`. The latter two were a bit inconsistent with the functions they performed and with similar constructors for related types in the Rust ecosystem. To remedy this, the constructors were updated to match [`uuid::Uuid`](https://docs.rs/uuid/0.8.2/uuid/struct.Uuid.html#method.from_bytes)'s constructor API:
- `ObjectId::with_bytes` => `const ObjectId::from_bytes`
- `ObjectId::with_string` => `ObjectId::parse_str`
##### Error naming improvements ([C-WORD-ORDER](https://rust-lang.github.io/api-guidelines/naming.html#c-word-order), [C-STABLE](https://rust-lang.github.io/api-guidelines/necessities.html#c-stable))
Some error variants were renamed or restructured to be clearer or more informative. A complete summary of the changes are as follows:
- `bson::de::Error`:
- `IoError` => `Io`
- `FromUtf8Error` => `InvalidUtf8String`
- `SyntaxError` => *removed*, consolidated into `DeserializationError`.
- `InvalidTimestamp(i64)` => `InvalidDateTime { key: String, datetime: i64 }`
- `bson::ser::Error`:
- `IoError` => `Io`
- `InvalidMapKeyType { key: Bson }` => `InvalidDocumentKey(Bson)`
- `UnsupportedUnsignedType` => *removed*
- `UnsignedTypesValueExceededRange` => `UnsignedIntegerExceededRange(u64)`
- `oid::Error`:
- `ArgumentError` => *removed*
- `FromHexError` => *removed*, replaced by the new `InvalidHexStringCharacter` and `InvalidHexStringLength` variants
##### Other miscellaneous changes
There were some other smaller breaking changes made as part of this as well:
- Ensure public structs are future proof by marking them as `non_exhaustive` ([C-STRUCT-PRIVATE](https://rust-lang.github.io/api-guidelines/future-proofing.html#c-struct-private))
- `document::DocumentIterator` and `document::DocumentIntoIterator` renamed to `document::Iter` and `document::IntoIter` ([C-ITER-TY](https://rust-lang.github.io/api-guidelines/naming.html#c-iter-ty))
#### Enable the `u2i` behavior by default (RUST-968)
In the 1.x version of `bson`, unsigned integers could not be serialized to BSON by default, but the `u2i` feature flag could be enabled to allow them to be serialized by automatically converting them to signed integers. After some investigation, it was determined that this `u2i` behavior was more consistent with the behavior of BSON libraries in other languages with unsigned integers, so `bson` now exhibits it by default, and the `u2i` feature flag was removed.
#### Implement `Clone` on all error types (RUST-738)
Previously many of the error types did not implement `Clone`, partially because many of them wrapped `std::io::Error`. Not implementing `Clone` made these errors difficult to work with, since they needed to be wrapped in an `Arc` or `Rc` in order to be passed around without transferring ownership. To avoid that requirement, we implemented `Clone` on all of the error types in `bson`. For the errors that wrapped `std::io::Error`, this required wrapping the wrapped `std::io::Error`s in `Arc`s.
#### Implement `Copy` for `ObjectId` (RUST-680)
Since `ObjectId` is just a wrapper around a 12-byte array, it is cheap to copy and therefore ought to implement `Copy`. As part of this, helpers on `Document` and `Bson` were updated to return owned `ObjectId`s instead of references to them.
Thanks to [@jcdyer](https://togithub.com/jcdyer) for contributing this change!
#### Replace `linked-hash-map` with `indexmap` (RUST-283)
The dependency on the now unmaintained `linked-hash-map` was replaced with the more up-to-date `indexmap`. While this isn't a breaking change on its own, the `Entry` API of `Document` was updated to match both that of `std::collections::HashMap` and `indexmap` in a breaking way.
#### Replace `compat::u2f` with serde helpers (RUST-756)
The `compat::u2f` module has long existed to provide a way to serialize unsigned integers as BSON doubles, but it is inconsistent with the API we provide for these kinds of conversions today, namely the `serde_helpers` functions and modules. In order to present a more consistent API, the `compat::u2f` module was removed and most of its conversion helpers were rewritten as `serde_helpers`.
#### Remove the `decimal128` feature flag (RUST-960, [#287](https://togithub.com/mongodb/bson-rust/issues/287))
It was determined that the BSON serialization format that was used when the experimental `decimal128` feature flag was enabled did not match the format expected by the database or other MongoDB tools and drivers. Because of this, the feature flag has been removed, as there was no way to use it correctly. See [#282](https://togithub.com/mongodb/bson-rust/issues/282) for more details.
If you were relying on this feature flag or are just interested in a complete decimal128 implementation, please let us know on [#53](https://togithub.com/mongodb/bson-rust/issues/53).
#### Support for serialization to and deserialization from BSON bytes (RUST-870, RUST-871, [#276](https://togithub.com/mongodb/bson-rust/issues/276), [#279](https://togithub.com/mongodb/bson-rust/issues/279))
This release adds support for direct serialization to and deserialization from BSON bytes via `bson::to_vec` and `bson::from_slice` / `bson::from_reader`, eliminating the need to go through `Document` when converting between Rust data types and BSON bytes. This can enable significant performance improvements in certain circumstances; most notably, this will greatly improve the performance of the MongoDB driver, which in `2.0.0` will begin leveraging this functionality.
#### Properly produce and ingest RFC 3339 (ISO 8601) datetimes in serde helpers (RUST-825)
The `iso_string_as_bson_datetime` and `bson_datetime_as_iso_string` serde helpers were not producing or only accepting valid ISO 8601 strings. This has been fixed, and the helpers have been renamed to `rfc3339_string_as_bson_datetime` and `bson_datetime_as_rfc3339_string` to more accurately reflect the standard they conform to.
#### Introduce serde helpers for legacy UUID formats (RUST-687)
The Python, Java, and C# drivers all used to serialize UUIDs with different legacy formats, none of which were supported by the existing UUID serde helper. To add support for serializing and deserializing these UUIDs, new serde helpers were introduced for each of the legacy formats. These helpers are also gated behind the `"uuid-0_8"` feature flag.
Thanks to [@kenkoooo](https://togithub.com/kenkoooo) for contributing this change!
#### Add pretty-printed `Debug` implementation to BSON types (RUST-282)
BSON related types now support being pretty-printed via the `{:#?}` format specifier.
e.g.
```rust
let doc = doc! {
"oid": ObjectId::new(),
"arr": Bson::Array(vec! [
Bson::Null,
Bson::Timestamp(Timestamp { time: 1, increment: 1 }),
]),
"doc": doc! { "a": 1, "b": "data"},
};
println!("{:#?}", doc);
```
Prints the following:
Document({
"oid": ObjectId(
"60d60c360026a43f00e47007",
),
"arr": Array([
Null,
Timestamp {
time: 1,
increment: 1,
},
]),
"doc": Document({
"a": Int32(
1,
),
"b": String(
"data",
),
}),
})
#### Implement `From>` for `Bson` where `T: Into` (RUST-806)
A blanket `From>` implementation was added for `T` that implement `Into`. If the value is `Some(T)`, the `T` is converted into `Bson` using `T`'s `Into` implementation, and if it's `None`, it will be converted into `Bson::Null`.
A nice benefit of this is that `Option` can now be used in the `bson!` and `doc!` macros directly:
```rust
let some: Option = Some(5);
let none: Option = None;
let doc = doc! {
"some": some,
"none": none,
};
println!("{}", doc);
```
Prints:
```json
{ "some": 5, "none": null }
```
### Full Release Notes
#### New Features
- RUST-687 Introduce serde helpers for legacy UUID formats (thanks [@kenkoooo](https://togithub.com/kenkoooo)!)
- RUST-688 Support for borrowed deserialization ([#276](https://togithub.com/mongodb/bson-rust/issues/276))
- RUST-870 Support deserializing directly from raw BSON ([#276](https://togithub.com/mongodb/bson-rust/issues/276))
- RUST-871 Support serializing directly to BSON bytes ([#279](https://togithub.com/mongodb/bson-rust/issues/279))
- RUST-680 Implement `Copy` for `ObjectId` **(breaking)**
- RUST-747 Add serde helper to deserialize hex string from `ObjectId` (thanks [@moka491](https://togithub.com/moka491)!)
- RUST-738 Implement `Clone` on BSON error types **(breaking)**
- RUST-806 Implement `From>` for `Bson` where `T: Into`
- RUST-841 Mark `ObjectId::bytes` as `const`
- RUST-868 Add `serialize_object_id_as_hex_string` serde helper
- RUST-282 Add pretty-printed `Debug` implementation to BSON types
#### Improvements
- RUST-283 Replace `linked-hash-map` with `indexmap` **(breaking)**
- RUST-711 Use `imports_granularity=Crate` in rustfmt config
- RUST-756 Replace `compat::u2f` with serde helpers **(breaking)**
- RUST-739 Don't re-export types from unstable dependencies **(breaking)**
- RUST-789 Standardize on `ObjectId` conversion constructors **(breaking)**
- RUST-788 Accept `impl AsRef` instead of `&str` in `Document` methods **(breaking)**
- RUST-765 Ensure API follows Rust API Guidelines **(breaking)**
- RUST-889 Avoid going through hex string when deserializing `ObjectId` from raw bytes ([#287](https://togithub.com/mongodb/bson-rust/issues/287))
- Thanks [@univerz](https://togithub.com/univerz) for the POC for this!
- RUST-960 Remove `decimal128` feature flag and functionality (**breaking**)
- RUST-882 Remove lossy `From` impl for `Bson` ([#280](https://togithub.com/mongodb/bson-rust/issues/280)) (**breaking**)
- RUST-811 `bson::DateTime` ergonomic improvements **(breaking)**
- RUST-815 Truncate `chrono::DateTime` to millisecond precision when converting to `bson::DateTime` **(breaking)** (thanks [@vkill](https://togithub.com/vkill)!)
- RUST-826 Take ownership of `self` in `ObjectId::to_hex` **(breaking)**
- RUST-672 Introduce new `BinarySubtype` case for user-defined values
- RUST-838 Improve `bson::DateTime::now()` performance (thanks [@pymongo](https://togithub.com/pymongo)!)
- RUST-846 Unify `Display` and `Debug` implementations for `Bson`
- RUST-861 Support deserializing `ObjectId` from non self-describing formats (thanks for reporting [@univerz](https://togithub.com/univerz)!)
- RUST-876 Quote keys in `Document`'s `Display` implementation
- RUST-996 Bump `rand` dependency to 0.8 (thanks [@seanpianka](https://togithub.com/seanpianka)!)
#### Bugfixes
- RUST-884 Support deserializing `DateTime`s between the year 10,000 and 99,999
- RUST-942 Generate 5 random bytes instead of 3 for ObjectIds ([#284](https://togithub.com/mongodb/bson-rust/issues/284))
- RUST-713 Fix underflow on BSON array and binary deserialization (thanks [@gperinazzo](https://togithub.com/gperinazzo) and [@5225225](https://togithub.com/5225225)!)
- RUST-799 Fix errors and panics caused by datetimes with large distance to epoch
- RUST-825 Update serde helpers to properly conform with RFC 3339 (ISO 8601) **(breaking)**
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about these updates again.
[ ] If you want to rebase/retry this PR, click this checkbox.
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
1.2.4->2.4.02.0->2.4Release Notes
mongodb/bson-rust
### [`v2.4.0`](https://togithub.com/mongodb/bson-rust/releases/tag/v2.4.0) [Compare Source](https://togithub.com/mongodb/bson-rust/compare/v2.3.0...v2.4.0) ### Description The MongoDB Rust driver team is pleased to announce the v2.4.0 release of the `bson` crate. ### Highlighted Changes The following sections detail some of the more important changes included in this release. For a full list of changes, see the [Full Release Notes](#full-release-notes) section below. #### Support for 1.x of the `uuid` crate The `bson` crate now has a `uuid-1` feature that provides an API for interoperation with versions 1.x of the `uuid` crate, similar to the existing `uuid-0_8` feature. Internal usage of `uuid` now uses 1.x, so downstream crates without a need for 0.8 will no longer transitively depend on both version. #### Builder for `DateTime` values The `DateTime` type now provides a builder that allows convenient construction from a given `year`, `month`, `day`, and optionally, an `hour`, `minute`, `second` and `millisecond`. ### Full Release Notes #### New Features - RUST-1305 Add support for version 1.x of the uuid crate to the bson crate - RUST-1198 Support creating bson::DateTime from a given year/month/date/hour/minute/second/millisecond #### Tasks - RUST-1398 Pin `clippy` version to 1.62.0 - RUST-1374 Pin all dependencies when checking MSRV compilation ### [`v2.3.0`](https://togithub.com/mongodb/bson-rust/releases/tag/v2.3.0) [Compare Source](https://togithub.com/mongodb/bson-rust/compare/v2.2.0...v2.3.0) ### Description The MongoDB Rust driver team is pleased to announce the `2.3.0` release of the `bson` crate. This release increases the crate's MSRV to 1.53 and makes the crate's dependency on `chrono` optional. ### Full Release Notes #### Task - RUST-1263 Bump MSRV to 1.53 ([#352](https://togithub.com/mongodb/bson-rust/issues/352)) #### Improvement - RUST-1129 Replace `chrono` dependency with `time` ([#352](https://togithub.com/mongodb/bson-rust/issues/352)) ### [`v2.2.0`](https://togithub.com/mongodb/bson-rust/releases/tag/v2.2.0) [Compare Source](https://togithub.com/mongodb/bson-rust/compare/v2.1.0...v2.2.0) ### Description The MongoDB Rust driver team is pleased to announce the v2.2.0 release of the `bson` crate. ### Highlighted Changes The following sections detail some of the more important changes included in this release. For a full list of changes, see the [Full Release Notes](#full-release-notes) section below. #### Raw BSON (RUST-284, RUST-1045, RUST-1082, RUST-1109, RUST-1111, RUST-1119) Both of the existing ways of working with BSON values (the `BSON` type or using Serde) require parsing the values up-front. This can be a performance bottleneck in certain circumstances; to address this, we've introduced the `RawBson`, `RawDocument`, and `RawArray` types. These types provide an interface similar to the existing BSON types, but are backed by a buffer of BSON bytes rather than a fully parsed `enum` or hash map. This enables zero-copy reads with minimal parsing and highly memory-efficient manipulation. In tradeoff, these types do not provide the full set of operations that the standard ones can, and the performance of element access is O(N) rather than then average O(1) of the parsed types. Thanks to [@jcdyer](https://togithub.com/jcdyer) for contributing the initial implementation! ### Full Release Notes #### New Features - RUST-284 Incorporate raw BSON code from rawbson = "0.2.1" in mod raw ([#229](https://togithub.com/mongodb/bson-rust/issues/229)) - RUST-1045 Support appending to RawDocumentBuf ([#326](https://togithub.com/mongodb/bson-rust/issues/326)) - RUST-1109 Implement rawbson! and rawdoc! macros ([#329](https://togithub.com/mongodb/bson-rust/issues/329)) - RUST-1119 Add bson::to_raw_document_buf function ([#330](https://togithub.com/mongodb/bson-rust/issues/330)) - RUST-1111 Support deserializing RawBson from Bson ([#331](https://togithub.com/mongodb/bson-rust/issues/331)) - minor: raw BSON perf and API improvements ([#335](https://togithub.com/mongodb/bson-rust/issues/335)) #### Bugfixes - RUST-1243 Handle enum keys when deserializing a map from binary ([#348](https://togithub.com/mongodb/bson-rust/issues/348)) (thanks [@George-Miao](https://togithub.com/George-Miao)!) - RUST-1240 Fix potential underflow in length counting ([#349](https://togithub.com/mongodb/bson-rust/issues/349)) - RUST-1195 Add missing trait impls to Uuid ([#345](https://togithub.com/mongodb/bson-rust/issues/345)) ### [`v2.1.0`](https://togithub.com/mongodb/bson-rust/releases/tag/v2.1.0) [Compare Source](https://togithub.com/mongodb/bson-rust/compare/v2.0.1...v2.1.0) ### Description The MongoDB Rust driver team is pleased to announce the `v2.1.0` release of the `bson` crate. ### Highlighted changes The following sections detail some of the more important changes included in this release. For a full list of changes, see the [Full Release Notes](#full-release-notes) section below. #### Better `Uuid` ergonomics (RUST-819, RUST-465, RUST-1024) Working with UUIDs in BSON is a bit of a pain point, since the widely used `Uuid` type from the `uuid` crate doesn't serialize to or from BSON UUIDs (i.e. Binary with subtype 4) out of the box. To address this, we introduced a `bson::Uuid` type, which serializes as a BSON UUID when using `bson::to_bson` or `bson::to_slice` and uses `uuid::Uuid`'s `Serialize` implementation for other formats. Additionally, we implemented the UUID [driver specification](https://togithub.com/mongodb/specifications/blob/master/source/uuid.rst), which enables easy conversion between `Binary` and `bson::Uuid`. It also adds support for handling BSON UUIDs that may have been serialized using the legacy format from one of the other MongoDB drivers (Python, Java, or C#). Lastly, we introduced support for using the [`serde_with`](https://docs.rs/serde_with/1.11.0/serde_with/) crate to serialize `uuid::Uuid`s to BSON. This requires the usage of the `serde_with` and `uuid-0_8` feature flags. See the next section for more details. #### `serde_with` integration (RUST-1024) As mentioned in the previous section, we've added optional support for the [`serde_with`](https://docs.rs/serde_with/1.11.0/serde_with/) crate via the `serde_with` feature flag. Right now, this allows for serialization of `chrono::DateTime` as `bson::DateTime` (with the `chrono-0_4` feature flag) and `uuid::Uuid` as `bson::Uuid` (with the `uuid-0_8` feature flag). The main improvement of `serde_with` annotations over the existing serde helpers is that they also work when the `Uuid` or `DateTime` type is nested, such as in an `Option`. ```rust #[serde_with::serde_as] #[derive(Serialize, Deserialize, Debug)] struct MyData { #[serde_as(as = "OptionConfiguration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about these updates again.
This PR has been generated by Mend Renovate. View repository job log here.