tree: a60e01cd5099929492440877e49d3b9c5f6eb0da [path history] [tgz]
  1. src/
  2. BUILD.gn
  3. OWNERS
  4. README.md
src/lib/diagnostics/inspect/node-hierarchy/rust/README.md

fuchsia_inspect_node_hierarchy

fuchsia_inspect_node_hierarchy is a library that contains the Node Hierarchy that is read out of an Inspect VMO. Docs are available here.

Building

This project should be automatically included in builds.

Using

fuchsia_inspect_node_hierarchy can be used by depending on the //src/lib/diagnostics/inspect/node-hierarchy/rust GN target and then using the fuchsia_inspect_node_hierarchy crate in a Rust project.

fuchsia_inspect_node_hierarchy is not available in the SDK.

Testing

Unit tests for fuchsia_inspect_node_hierarchy are available in the fuchsia_inspect_node_hierarchy_tests package:

$ fx run-test fuchsia_inspect_node_hierarchy_tests

You'll need to include //src/lib/diagnostics/inspect/node-hierarchy/rust:tests in your build, either by using fx args to put it under universe_package_labels, or by fx set [....] --with //src/lib/diagnostics/inspect/node-hierarchy/rust:tests.

Benchmarking

Benchmarks for fuchsia_inspect_node_hierarchy are available in the rust_inspect_benchmarks package.

One way to run the benchmarks is with the following command:

$ fx run-e2e-tests rust_inspect_benchmarks_test

It is possible to run the benchmarks in a fast “unit test mode” with the following test command. This runs a small number of test iterations without collecting performance results, which can be useful for checking that the tests don't fail:

$ fx shell run rust_inspect_benchmarks --benchmark writer

You'll need to include //src/lib/diagnostics/inspect/node-hierarchy/rust:benchmarks in your build, either by using fx args to put it under universe_package_labels, or by fx set [....] --with //src/lib/diagnostics/inspect/node-hierarchy/rust:benchmarks.