RUST-1607: allow uuidRepresentation in connection string #838
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
abr-egn
reviewed
Mar 2, 2023
src/client/options/mod.rs
Outdated
| @@ -813,6 +815,10 @@ pub struct ConnectionString { | |||
| /// Default read preference for the client. | |||
| pub read_preference: Option<ReadPreference>, | |||
|
|
|||
| /// The `uuidRepresentation` to use when decoding UuidOld bindata types. This serves as a caching | |||
There was a problem hiding this comment.
Suggestion:
/// The `uuidRepresentation` to use when decoding UuidOld bindata types. This is not used by the driver; client code can use this when deserializing relevant values with `to_uuid_with_representation`.
src/client/options/mod.rs
Outdated
| "javalegacy" => self.uuid_representation = Some(UuidRepresentation::JavaLegacy), | ||
| "pythonlegacy" => self.uuid_representation = Some(UuidRepresentation::PythonLegacy), | ||
| _ => return Err(ErrorKind::InvalidArgument { | ||
| message: format!("connection string `uuidRepresentation` option can be one of `csharpLegacy`, `javaLegacy`, or `pythonLegacy`. Received invalid `{value}`") |
There was a problem hiding this comment.
Sadly, our MSRV doesn't support inline format identifiers, so this will need to use the older format.
abr-egn
approved these changes
Mar 2, 2023
patrickfreed
reviewed
Mar 3, 2023
src/client/options/mod.rs
Outdated
| @@ -813,6 +815,11 @@ pub struct ConnectionString { | |||
| /// Default read preference for the client. | |||
| pub read_preference: Option<ReadPreference>, | |||
|
|
|||
| /// The `uuidRepresentation` to use when decoding UuidOld bindata types. This is not used by | |||
There was a problem hiding this comment.
Suggested change
| /// The `uuidRepresentation` to use when decoding UuidOld bindata types. This is not used by | |
| /// The [`UuidRepresentation`] to use when decoding [`Binary`] values with the `UuidOld` subtype. This is not used by |
There was a problem hiding this comment.
I believe this should link to the proper bson types in the docs.rs documentation.
src/client/options/mod.rs
Outdated
| @@ -813,6 +815,11 @@ pub struct ConnectionString { | |||
| /// Default read preference for the client. | |||
| pub read_preference: Option<ReadPreference>, | |||
|
|
|||
| /// The `uuidRepresentation` to use when decoding UuidOld bindata types. This is not used by | |||
| /// the driver; client code can use this when deserializing relevant values with | |||
| /// `to_uuid_with_representation`. | |||
There was a problem hiding this comment.
Suggested change
| /// `to_uuid_with_representation`. | |
| /// [`Binary::to_uuid_with_representation`]. |
isabelatkinson
approved these changes
Mar 3, 2023
|
Thanks for the feedback! I've updated it so the doc comments links appropriately, and looks halfway decent. |
patrickfreed
approved these changes
Mar 9, 2023
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.
This adds
uuidRepresentationtoConnectionString.I wasn't sure what to put for the documentation comment, it could probably be cleaned up.