Support component enum, variant, flags types
#397
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
Decision: the enum string is not validated against the list of possible
values. The rationale is that Wasmtime will validate it at a later
point, thus by adding an extra validation we're incurring the cost
twice.
The tradeoff is that we need to rely on Wasmtime's error message which
does not include the list of valid values.
An implementation of validation would look like:
```rust
// SAFETY: we're only calling into Ruby after we're done using the str
let rstring_str = unsafe { rstring.as_str()? };
if !enum_.names().any(|name| name == rstring_str) {
return err!(
"invalid enum value \"{}\", valid values: {:?}",
rstring_str,
RArray::from_iter(enum_.names())
);
}
```
And the test:
```ruby
["enum", "no", /invalid enum value "no", valid values: \["s", "m", "l"\]/],
```
Flags are passed to/from Ruby as `Array<String>`, matching the Wasmtime's `Val::Flags`. Similar to enum types, the strings are not matched against valid flags given the rust layer does when lowering the flags.
saulecabrera
approved these changes
Nov 5, 2024
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.
Add support for
enum,variantandflagscomponent model types.enum: maps to a Ruby String. The string is not validated at convert time given Wasmtime will validate it at a later point. By adding an extra validation, we'd incur the validation cost twice. The tradeoff here is that the error happens outside of the conversion where we can no longer add additional context to the error message (e.g. list of valid values, which arg the error occurred in, etc.)variant: maps to aWasmtime::Component::Variantsimilar toresult.flags: maps to a Ruby Array of Strings, reflectingVal::Flagswhich wraps aVec<String>.