Skip to content
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

Add Natvis visualizations for ArrayVec and ArrayString types #225

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ridwanabdillahi
Copy link

This change adds Natvis visualizations for ArrayVec and ArrayString 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 ArrayVec and/or ArrayString under 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 both ArrayVec and ArrayString.
Tests for testing visualizers embedded in the arrayvec crate.
Updates to the CI pipeline to ensure tests for visualizers are run so they do not break silently.
A new debugger_visualizer feature for the arrayvec crate to enable the unstable debugger_visualizer Rust feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant