Add Natvis visualizations for core indexmap types
#239
Conversation
…g Natvis definitions do not become stale or break silently.
| feature = "debugger_visualizer", | ||
| feature(debugger_visualizer), | ||
| debugger_visualizer(natvis_file = "../debug_metadata/indexmap.natvis") | ||
| )] |
There was a problem hiding this comment.
I'm personally very wary of using any unstable features in a stable crate, even behind an optional feature.
There was a problem hiding this comment.
I understand, the goal is to push the debugger_visualizer feature to stabilization relatively soon by having it provide value to crates in the wild today as with any unstable feature.
As you said it is gated behind an optional feature but you as the crate maintainer would have to potentially take on an extra cost which I fully understand could be worrisome.
There was a problem hiding this comment.
Well, I gave approval for CI to run, at least, so it can be a proof of concept for the feature.
There was a problem hiding this comment.
Great! I see the CI was green and tests passed. Thanks for approving the CI job.
There was a problem hiding this comment.
@cuviper Do you have any reservations about taking in this change now that the CI shows as green?
There was a problem hiding this comment.
Passing CI is necessary, but doesn't change the maintenance aspect. If the unstable feature changes, as it is allowed, then we'll have to update again to fix our own CI. That's especially true if any users (on nightly) start depending on it (providing "value in the wild").
For ad hoc demonstrations in the meantime, you could use cargo's patch mechanisms to point at your git fork.
…et` and `IndexMap`.
|
The feature was stabilized in rust-lang/rust#108668, headed for Rust 1.71. Does this PR need updating for that? At the very least, we should not need the |
This change adds Natvis visualizations for some
indexmaptypes to help improve the debugging experience on Windows.Natvis is a framework that can be used to specify how types should be viewed under a supported debugger, such as the Windows debugger (WinDbg) and the Visual Studio debugger.
When debugging types such as
IndexMapand/orIndexSetunder a Windows debugger, the entries for these data structures are not always clear upon first glance. The internal data structure is shown and it's not presented in a user friendly way. The Rust compiler does have Natvis support for some types, but this is limited to some of the core libraries and not supported for external crates.rust-lang/rfcs#3191 proposes adding support for embedding debugging visualizations such as Natvis in a Rust crate. This RFC has been approved, merged and implemented.
This PR adds:
Natvis visualizations for some of the core types such as
IndexMapandIndexSet.Tests for testing visualizers embedded in the
indexmapcrate.Updates to the CI pipeline to ensure tests for visualizers are run so they do not break silently.
A new
debugger_visualizerfeature for theindexmapcrate to enable the unstabledebugger_visualizerRust feature.