Add span information for TOML imports #1949
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
yannham
force-pushed
the
feat/spanned-toml-values
branch
from
83294f1 to
7b1f31a
Compare
yannham
force-pushed
the
feat/spanned-toml-values
branch
from
7b1f31a to
f3dc2f3
Compare
yannham
force-pushed
the
feat/spanned-toml-values
branch
from
f3dc2f3 to
b144353
Compare
yannham
force-pushed
the
feat/spanned-toml-values
branch
from
b144353 to
3874d05
Compare
This commits use a feature of the toml crate allowing to embed span information into the deserialized data (imported from Nickel). This makes it possible to give nice error messages and point to within a TOML file when the application of a Nickel contract to an existing TOML configuration fails, or in case of unmergeable values. Doing so requires a bit of boilerplate and brings an additional crate in (although small). It can also impact deserialization performance, because we need to first deserialize in an intermediate TOML-like datastructure. For those reasons, spanned deserialization has been gated by the `spanned-deser` feature, which is enabled by default, but can be disabled if this isn't useful.
yannham
force-pushed
the
feat/spanned-toml-values
branch
from
3874d05 to
d91ee15
Compare
jneem
approved these changes
Jun 12, 2024
I do think it's worth the extra feature. There is a tendency to blow up the dependencies of any given crate. And since the code for when this feature is disabled is so small, why not hide it behind a feature flag. I approve. I would like to see some "real" performance measurements though. |
ErinvanderVeen
approved these changes
Jun 12, 2024
|
Actual measurement is the path forward, yes. In the meantime, another parameter is that the |
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 PR uses a feature of the
tomlcrate allowing to embed span information into the deserialized data (imported from Nickel). This makes it possible to give nice error messages and point to within a TOML file when the application of a Nickel contract to an existing TOML configuration fails, or in case of non-mergeable values.Doing so requires a bit of boilerplate and brings an additional crate in (although small). It can also impact deserialization performance, because we need to first deserialize in an intermediate TOML-like datastructure. For those reasons, spanned deserialization has been gated by the
spanned-deserfeature, which is enabled by default, but can be disabled if this isn't useful.