RUST-1886 Provide an opt-in "serialize as bytes" helper for ObjectId #582
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -50,6 +53,10 @@ enum SerializerHint { | |||
|
|
|||
| /// The next call to `serialize_bytes` is for the purposes of serializing a raw array. | |||
| RawArray, | |||
|
|
|||
| /// The next call to `serialize_bytes` is for the porpoises of serializing an ObjectId. | |||
| @@ -70,6 +70,40 @@ pub mod object_id { | |||
| Ok(oid.to_hex()) | |||
| } | |||
| ); | |||
|
|
|||
| pub(crate) const OID_BYTES_NEWTYPE: &str = "$__bson_private_oid_bytes"; | |||
| /// When serializing to a non-human-readable destination, will represent the [`ObjectId`] as a | |||
There was a problem hiding this comment.
If we eliminated the human-readable-specific logic here, could users get the same effect with:
#[serde_as(as = "IfIsHumanReadable<serde_with::Same, object_id::AsBytes>")]
oid: ObjectId,?
I'd prefer not to be opinionated about human-readable in these helpers if we can avoid it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RUST-1886
The default extjson representation used when serializing can be problematic for some
serdeserializers (see #457). However, changing it to always directly serialize as a byte array (the "newtype pattern" referenced in that bug) runs the risk of breaking other users who might be, intentionally or not, relying on the current serialization format.This PR threads the needle by providing a
serde_withhelper so that people who need the byte array serialization behavior can opt into it; care is taken to make sure all the normal serialization paths still work when the helper is enabled, i.e. objectids are still serialized as objectids and not generic arrays.