[Rust] Misc `binary_view` module refactoring by emesare · Pull Request #8120 · Vector35/binaryninja-api

emesare · 2026-04-23T20:05:01Z

Remove the "viral" BinaryViewExt trait and its blanket impl
Split up the binary view type from the custom trait impl
Simplify and fix bugs regarding custom binary view initialization
Rewrite Minidump binary view example, parses the PE headers to create proper sections now
Add some extra documentation
Add unit test for custom binary view

This is in preparation for bundling some rust view types such as the aforementioned minidump one, and potential replacements for other existing view types.

The removal of BinaryViewExt also fixes some cases where LSPs will trip up do to its blanket impl and suggest functions from it in completely wrong scenarios, although that itself was not the reasoning behind the change, its more so to do with the fact those functions are invalid in the case of a CustomBinaryView that has yet to have its core object constructed.

Supersedes #8061

Copilot

Pull request overview

Refactors the Rust binary_view API surface to remove the “viral” BinaryViewExt trait and rework custom binary view registration/initialization, while updating the Minidump view plugin and downstream crates/tests/examples to the new APIs.

Changes:

Move/reshape custom binary view registration and traits into rust/src/binary_view.rs, and remove the old custom_binary_view module.
Rewrite the Minidump view to use the new custom view traits and improve module/section handling.
Update Rust tests, examples, architectures, and plugins to stop using BinaryViewExt and adopt the new APIs.

Reviewed changes

Copilot reviewed 97 out of 102 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
view/minidump/src/view.rs	Rewritten Minidump view using new `CustomBinaryView` API; adds PE parsing for sections/symbols.
view/minidump/src/lib.rs	Registers the Minidump view via `register_binary_view_type`.
view/minidump/src/command.rs	Deleted old command implementation.
view/minidump/README.md	Simplified documentation for the Minidump view.
view/minidump/Cargo.toml	Bumps `minidump` and adds `object` dependency.
view/minidump/.gitignore	Deleted plugin-local ignore file.
rust/tests/types.rs	Removes `BinaryViewExt` import usage.
rust/tests/type_library.rs	Removes `BinaryViewExt` import usage.
rust/tests/type_container.rs	Removes `BinaryViewExt` import usage.
rust/tests/section.rs	Removes `BinaryViewExt` import usage.
rust/tests/repository.rs	Updates `RepositoryManager` usage to new static-style API.
rust/tests/render_layer.rs	Removes `BinaryViewExt` import usage.
rust/tests/medium_level_il.rs	Removes `BinaryViewExt` import usage.
rust/tests/low_level_il.rs	Removes `BinaryViewExt` import usage.
rust/tests/language_representation.rs	Removes `BinaryViewExt` import usage.
rust/tests/high_level_il.rs	Removes `BinaryViewExt` import usage.
rust/tests/function.rs	Removes `BinaryViewExt` import usage.
rust/tests/debug_info.rs	Removes `BinaryViewExt` import usage.
rust/tests/data_renderer.rs	Removes `BinaryViewExt` import usage.
rust/tests/data_notification.rs	Removes `BinaryViewExt` import usage.
rust/tests/component.rs	Removes `BinaryViewExt` import usage.
rust/tests/collaboration.rs	Removes `BinaryViewExt` import usage.
rust/tests/binary_writer.rs	Removes `BinaryViewExt` import usage.
rust/tests/binary_view.rs	Adds custom view unit test and updates imports to new custom-view APIs.
rust/tests/binary_reader.rs	Removes `BinaryViewExt` import usage.
rust/tests/base_detection.rs	Removes `BinaryViewExt` import usage.
rust/src/workflow.rs	Removes `BinaryViewExt` import usage in docs/support code.
rust/src/types/structure.rs	Updates doc links/imports away from `BinaryViewExt`.
rust/src/types/library.rs	Updates doc links/imports away from `BinaryViewExt`.
rust/src/types.rs	Updates imports/docs away from `BinaryViewExt`.
rust/src/segment.rs	Adds documentation for `SegmentBuilder::parent_backing`.
rust/src/section.rs	Updates docs away from `BinaryViewExt`.
rust/src/platform.rs	Updates docs away from `BinaryViewExt`.
rust/src/lib.rs	Removes `custom_binary_view` module export.
rust/src/function.rs	Updates docs/imports away from `BinaryViewExt`.
rust/src/file_metadata.rs	Switches `BinaryViewType` import to the new location and improves `view_types` docs.
rust/src/ffi.rs	Removes `BinaryViewExt` import from `ffi_span!` macro.
rust/src/debuginfo.rs	Updates docs away from `BinaryViewExt`.
rust/src/custom_binary_view.rs	Deleted old custom view implementation module.
rust/src/component.rs	Removes `BinaryViewExt` import usage.
rust/src/collaboration/sync.rs	Removes `BinaryViewExt` import usage and improves doc comment.
rust/src/collaboration/snapshot.rs	Removes `BinaryViewExt` import usage.
rust/src/collaboration/project.rs	Removes `BinaryViewExt` import usage.
rust/src/collaboration/file.rs	Removes `BinaryViewExt` import usage.
rust/src/binary_view/writer.rs	Removes `BinaryViewExt` import usage.
rust/src/binary_view.rs	Major refactor: new custom view registration + removal of `BinaryViewExt`.
rust/examples/workflow.rs	Removes `BinaryViewExt` import usage.
rust/examples/simple.rs	Removes `BinaryViewExt` import usage.
rust/examples/medium_level_il.rs	Removes `BinaryViewExt` import usage.
rust/examples/high_level_il.rs	Removes `BinaryViewExt` import usage.
rust/examples/flowgraph.rs	Removes `BinaryViewExt` import usage.
rust/examples/disassemble.rs	Removes `BinaryViewExt` import usage.
rust/examples/decompile.rs	Removes `BinaryViewExt` import usage.
rust/examples/bndb_to_type_library.rs	Removes `BinaryViewExt` import usage.
rust/README.md	Updates example to avoid `BinaryViewExt`.
plugins/workflow_objc/src/metadata/selector.rs	Removes `BinaryViewExt` import usage.
plugins/workflow_objc/src/metadata/global_state.rs	Adapts metadata fetching to new `get_metadata` return type.
plugins/workflow_objc/src/activities/util.rs	Removes `BinaryViewExt` import usage.
plugins/workflow_objc/src/activities/super_init.rs	Removes `BinaryViewExt` import usage.
plugins/workflow_objc/src/activities/remove_memory_management.rs	Removes `BinaryViewExt` import usage.
plugins/workflow_objc/src/activities/objc_msg_send_calls/adjust_call_type.rs	Removes `BinaryViewExt` import usage.
plugins/workflow_objc/src/activities/objc_msg_send_calls.rs	Removes `BinaryViewExt` import usage.
plugins/workflow_objc/src/activities/alloc_init.rs	Removes `BinaryViewExt` import usage.
plugins/warp/tests/matcher.rs	Removes `BinaryViewExt` import usage.
plugins/warp/tests/determinism.rs	Removes `BinaryViewExt` import usage.
plugins/warp/src/processor.rs	Removes `BinaryViewExt` import usage.
plugins/warp/src/plugin/workflow.rs	Removes `BinaryViewExt` import usage.
plugins/warp/src/plugin/load.rs	Removes `BinaryViewExt` import usage.
plugins/warp/src/matcher.rs	Removes `BinaryViewExt` import usage.
plugins/warp/src/lib.rs	Removes `BinaryViewExt` import usage.
plugins/warp/src/convert/types.rs	Removes `BinaryViewExt` import usage in tests.
plugins/warp/src/convert/symbol.rs	Removes `BinaryViewExt` import usage.
plugins/warp/src/cache/guid.rs	Removes `BinaryViewExt` import usage.
plugins/warp/src/cache/function.rs	Removes `BinaryViewExt` import usage.
plugins/warp/src/cache.rs	Removes `BinaryViewExt` import usage.
plugins/warp/benches/guid.rs	Removes `BinaryViewExt` import usage.
plugins/warp/benches/function.rs	Removes `BinaryViewExt` import usage.
plugins/warp/benches/convert.rs	Removes `BinaryViewExt` import usage.
plugins/svd/tests/mapper.rs	Removes `BinaryViewExt` import usage.
plugins/svd/src/mapper.rs	Removes `BinaryViewExt` import usage.
plugins/svd/src/lib.rs	Removes `BinaryViewExt` import usage.
plugins/pdb-ng/src/type_parser.rs	Removes `BinaryViewExt` import usage.
plugins/pdb-ng/src/parser.rs	Removes `BinaryViewExt` import usage.
plugins/pdb-ng/src/lib.rs	Removes `BinaryViewExt` import usage and updates metadata fetching.
plugins/idb_import/src/types.rs	Removes `BinaryViewExt` import usage.
plugins/idb_import/src/mapper.rs	Removes `BinaryViewExt` import usage.
plugins/idb_import/src/commands/load_file.rs	Removes `BinaryViewExt` import usage.
plugins/dwarf/shared/src/lib.rs	Removes `BinaryViewExt` import usage.
plugins/dwarf/dwarfdump/src/lib.rs	Removes `BinaryViewExt` import usage.
plugins/dwarf/dwarf_import/src/lib.rs	Removes `BinaryViewExt` import usage.
plugins/dwarf/dwarf_import/src/helpers.rs	Removes `BinaryViewExt` import usage.
plugins/dwarf/dwarf_import/src/dwarfdebuginfo.rs	Removes `BinaryViewExt` import usage.
plugins/dwarf/dwarf_export/src/lib.rs	Removes `BinaryViewExt` import usage.
plugins/bntl_utils/src/process.rs	Switches `BinaryViewType` import to new location; removes `BinaryViewExt` usage.
plugins/bntl_utils/src/dump.rs	Removes `BinaryViewExt` import usage.
plugins/bntl_utils/src/command/create.rs	Removes `BinaryViewExt` import usage.
arch/riscv/src/lib.rs	Updates to new `BinaryViewType::by_name` return type and removes old imports.
arch/msp430/src/lib.rs	Updates to new `BinaryViewType::by_name` return type and removes old imports.
Cargo.lock	Updates lockfile for new/updated dependencies (`minidump`, `object`, etc.).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Remove the "viral" `BinaryViewExt` trait and its blanket impl - Split up the binary view type from the custom trait impl - Simplify and fix bugs regarding custom binary view initialization - Rewrite Minidump binary view example, parses the PE headers to create proper sections now - Add some extra documentation - Add unit test for custom binary view

bdash · 2026-04-24T18:42:52Z

+    ///
+    /// Use this to populate the [`BinaryView`] with sections, segments, and other view data.
+    ///
+    /// NOTE: You must add **at-least** one segment to the view, otherwise calls to [`BinaryViewType::create`]


at least is two words

bdash · 2026-04-24T18:46:16Z

+            )
+        };
+        if handle.is_null() {
+            // TODO: Free here?


Seems like the leaked box does need to be freed here?

bdash · 2026-04-24T18:47:10Z

+
+    /// Create a core instance of the [`CustomBinaryView`].
+    pub fn from_custom<C: CustomBinaryView>(
+        view_type_name: &str,


Why does this need the view type name to be passed in explicitly? Can it not be retrieved from the view?

bdash · 2026-04-24T18:53:03Z

-            Ok(unsafe { Settings::ref_from_raw(settings_handle) })
+            unsafe { BNBinaryViewGetLoadSettings(self.handle, view_type_name.as_ptr()) };
+        match settings_handle.is_null() {
+            true => Settings::new(),


Why is this changing to return a new Settings instance rather than returning an error or None? The equivalent C++ API looks to have a nullable return type.

emesare self-assigned this Apr 23, 2026

emesare added the Component: Rust API Issue needs changes to the Rust API label Apr 23, 2026

emesare force-pushed the test_rust_custom_view_refactor_0 branch 3 times, most recently from 330a92c to c9a922d Compare April 24, 2026 03:45

emesare marked this pull request as ready for review April 24, 2026 03:45

emesare requested review from bdash and Copilot April 24, 2026 03:45

Copilot started reviewing on behalf of emesare April 24, 2026 03:46 View session

Copilot AI reviewed Apr 24, 2026

View reviewed changes

Comment thread rust/src/binary_view.rs

Comment thread rust/src/binary_view.rs

Comment thread rust/src/binary_view.rs

Comment thread rust/src/binary_view.rs Outdated

Comment thread rust/src/binary_view.rs

emesare added 2 commits April 23, 2026 21:07

[Rust] Update repository API unit tests following recent changes

35c38a6

emesare force-pushed the test_rust_custom_view_refactor_0 branch from c9a922d to 35c38a6 Compare April 24, 2026 04:07

emesare mentioned this pull request Apr 24, 2026

[Rust] add the process step for the creation of a custom binary view #8061

Closed

emesare added this to the Krypton milestone Apr 27, 2026

bdash approved these changes Apr 28, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Rust] Misc `binary_view` module refactoring#8120

[Rust] Misc `binary_view` module refactoring#8120
emesare wants to merge 2 commits intodevfrom
test_rust_custom_view_refactor_0

emesare commented Apr 23, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bdash Apr 24, 2026

Uh oh!

bdash Apr 24, 2026

Uh oh!

bdash Apr 24, 2026

Uh oh!

bdash Apr 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

emesare commented Apr 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bdash Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

bdash Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

bdash Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

bdash Apr 24, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

emesare commented Apr 23, 2026 •

edited

Loading