-
Notifications
You must be signed in to change notification settings - Fork 79
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Make it easy to convert data to IDLValue and candid text format #502
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
Benchmark for adea395Click to view benchmark
|
chenyan-dfinity
approved these changes
Dec 6, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
annotate_types
is a best-effort implementation, notably subtyping is not supported. A better way is to use from_bytes_with_types
which implements everything from the official deserializer.
Benchmark for c8a2efcClick to view benchmark
|
Benchmark for 0c3da76Click to view benchmark
|
@chenyan-dfinity Thank you! |
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.
Overview
It is not well documented how to convert types that implement
CandidType
into anIDLValue
.Requirements
It is easy to convert instances of Rust types into
IDLValues
using the best available method.Considered Solutions
Recommended Solution
Provide a library method for converting data to Candid.
The current method - serializing and parsing - can probably be improved greatly, so it seems preferable to offer a conversion method in the candid library and then improve that method rather than document a method that is sub-optimal and then expect developers to update their code when a better method is documented.
Considerations
IDLValue::try_from_candid_type(data).unwrap().to_string()