Add non-consuming as_json method to Document struct
#406
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
Currently, when serializing a glTF `Document`, the responsible code must own the `Document` to call the `into_json` method. However, this requirement deviates from the usual read-only borrow requirement for serializing data. To overcome this, client code can arrange for passing around references to the inner `Root` struct, but doing so sacrifices the benefits provided by the `Gltf` and `Document` structs for better binary data handling. To improve on this, let's introduce a non-consuming `as_json` unwrapping method. This method takes the `Document` by reference and returns a reference to the inner `Root` structure. By doing this, its usage across various use cases is simplified, making the code more straightforward and intuitive.
|
This is fine, thanks. 👍 |
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.
Currently, when serializing a glTF
Document, the responsible code must own theDocumentto call theinto_jsonmethod. However, this requirement deviates from the usual read-only borrow requirement for serializing data. To overcome this, client code can arrange for passing around references to the innerRootstruct, but doing so sacrifices the benefits provided by theGltfandDocumentstructs for better binary data handling. (TheDerefimplementation forGltfcan also be used, but its syntax is somewhat unintuitive, and that does not apply toDocuments themselves.)To improve on this, let's introduce a non-consuming
as_jsonunwrapping method. This method takes theDocumentby reference and returns a reference to the innerRootstructure. By doing this, its usage across various use cases is simplified, making the code more straightforward and intuitive.