Swap UUID format to byte array #556
Merged
Conversation
This file contains 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
With deepmap#546 merged in, UUIDs are defined as an alias for a string. Before that implementation gets mass adoption, I wanted to propose a slightly different alternative: basing the custom type off of `uuid.UUID` over `string`. This has the advantages of: - Being convertable back to a `uuid.UUID` without having to parse the string a second time, or opening the conversion up to failure scenarios - Still being easily convertable to `string` with the `uuid.UUID`'s `String` method - Taking up less space in memory - Reducing the number of invalid representations, since only `[16]byte`s can be represented, as opposed to all strings - Not adding any dependencies, since `uuid.UUID` is already being imported
|
@deepmap-marcinr any possibility of a review on this? This would substantially lessen the burden on users to need to implement custom methids for marshaling/unmarshaling actual UUID types and greatly improve the usability of this project. |
hikhvar
pushed a commit
to hikhvar/oapi-codegen
that referenced
this pull request
Jun 3, 2022
We make heavy use of the new UUID feature introduced in deepmap#571, deepmap#546 and deepmap#556. However, we observed that using a UUID as parameter creates malformed strings in the requests made by the generated clients. This adds a special handling for types.UUID in the StyleParamWithLocation function. I'm not that happy with this approach. I would like to use an interface "MarshalParameter" for this with semantics similar to MarshalJSON. But that doesn't work for aliased types as UUIDs.
|
You're right, thanks. Odd, the tests were passing.
…________________________________________
From: Alex Dulin ***@***.***>
Sent: Tuesday, May 3, 2022 8:47 PM
To: deepmap/oapi-codegen
Cc: Marcin Romaszewicz; Mention
Subject: Re: [deepmap/oapi-codegen] Swap UUID format to byte array (PR #556)
@deepmap-marcinr<https://github.com/deepmap-marcinr> any possibility of a review on this? This would substantially lessen the burden on users to need to implement custom methids for marshaling/unmarshaling actual UUID types and greatly improve the usability of this project.
—
Reply to this email directly, view it on GitHub<#556 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ALKC5DDPOX5FDUE6KC73MILVIHXLXANCNFSM5UAJ7FRA>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
adrianpk
pushed a commit
to foorester/oapi-codegen
that referenced
this pull request
Jan 16, 2024
With deepmap#546 merged in, UUIDs are defined as an alias for a string. Before that implementation gets mass adoption, I wanted to propose a slightly different alternative: basing the custom type off of `uuid.UUID` over `string`. This has the advantages of: - Being convertable back to a `uuid.UUID` without having to parse the string a second time, or opening the conversion up to failure scenarios - Still being easily convertable to `string` with the `uuid.UUID`'s `String` method - Taking up less space in memory - Reducing the number of invalid representations, since only `[16]byte`s can be represented, as opposed to all strings - Not adding any dependencies, since `uuid.UUID` is already being imported
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.
With #546 merged in, UUIDs are defined as an alias for a string.
Before that implementation gets mass adoption, I wanted to propose a
slightly different alternative: basing the custom type off of
uuid.UUIDoverstring.This has the advantages of:
uuid.UUIDwithout having to parse thestring a second time, or opening the conversion up to failure
scenarios
stringwith theuuid.UUID'sStringmethod[16]bytescan be represented, as opposed to all strings
uuid.UUIDis already beingimported