| |
| |
| |
| # Inspect class |
| |
| |
| |
| |
| |
| |
| *[<Null safety>](https://dart.dev/null-safety)* |
| |
| |
| |
| <p><a href="../package-fuchsia_inspect_inspect/Inspect-class.md">Inspect</a> exposes a structured tree of internal component state.</p> |
| <p>The <a href="../package-fuchsia_inspect_inspect/Inspect-class.md">Inspect</a> object maintains a hierarchy of <a href="../package-fuchsia_inspect_inspect/Node-class.md">Node</a> objects whose data are |
| exposed for reading by specialized tools such as iquery.</p> |
| <p>The classes exposed by this library do not support reading.</p> |
| |
| |
| |
| |
| ## Constructors |
| |
| [Inspect](../package-fuchsia_inspect_inspect/Inspect/Inspect.md) () |
| |
| Returns a singleton <a href="../package-fuchsia_inspect_inspect/Inspect-class.md">Inspect</a> instance at root.inspect _factory_ |
| |
| [Inspect.forTesting](../package-fuchsia_inspect_inspect/Inspect/Inspect.forTesting.md) ([FakeVmoHolder](../package-fuchsia_inspect_testing/FakeVmoHolder-class.md) vmo) |
| |
| Returns a new <a href="../package-fuchsia_inspect_inspect/Inspect-class.md">Inspect</a> object at root.inspect backed by a fake VMO |
| intended for unit testing inspect integrations, so that they can run as |
| host tests. _factory_ |
| |
| |
| ## Properties |
| |
| ##### [hashCode](../package-fuchsia_inspect_inspect/Inspect/hashCode.md) → int |
| |
| |
| |
| The hash code for this object. |
| _read-only, inherited_ |
| |
| |
| |
| ##### [health](../package-fuchsia_inspect_inspect/Inspect/health.md) → HealthNode |
| |
| |
| |
| The health <a href="../package-fuchsia_inspect_inspect/Node-class.md">Node</a> of this Inspect tree. |
| _read-only_ |
| |
| |
| |
| ##### [root](../package-fuchsia_inspect_inspect/Inspect/root.md) → [Node](../package-fuchsia_inspect_inspect/Node-class.md)? |
| |
| |
| |
| The root <a href="../package-fuchsia_inspect_inspect/Node-class.md">Node</a> of this Inspect tree. |
| _read-only_ |
| |
| |
| |
| ##### [runtimeType](../package-fuchsia_inspect_inspect/Inspect/runtimeType.md) → Type |
| |
| |
| |
| A representation of the runtime type of the object. |
| _read-only, inherited_ |
| |
| |
| |
| |
| |
| ## Methods |
| |
| ##### [noSuchMethod](../package-fuchsia_inspect_inspect/Inspect/noSuchMethod.md)(Invocation invocation) dynamic |
| |
| |
| |
| Invoked when a non-existent method or property is accessed. |
| _inherited_ |
| |
| |
| |
| ##### [onDemand](../package-fuchsia_inspect_inspect/Inspect/onDemand.md)(String name, OnDemandRootFn rootNodeCallback) void |
| |
| |
| |
| Mounts an <a href="../package-fuchsia_inspect_inspect/Inspect-class.md">Inspect</a> file at <name>.inspect whose contents are |
| dynamically created by rootNodeCallback on each read.</name> |
| |
| |
| |
| |
| ##### [serve](../package-fuchsia_inspect_inspect/Inspect/serve.md)([Outgoing](../package-fuchsia_services_services/Outgoing-class.md) outgoing) void |
| |
| |
| |
| Attaches the inspect to the outgoing diagnostics/debug dir. |
| |
| |
| |
| |
| ##### [toString](../package-fuchsia_inspect_inspect/Inspect/toString.md)() String |
| |
| |
| |
| A string representation of this object. |
| _inherited_ |
| |
| |
| |
| |
| |
| ## Operators |
| |
| ##### [operator ==](../package-fuchsia_inspect_inspect/Inspect/operator_equals.md)(Object other) bool |
| |
| |
| |
| The equality operator. |
| _inherited_ |
| |
| |
| |
| |
| |
| ## Static Properties |
| |
| ##### [nameToInstanceCount](../package-fuchsia_inspect_inspect/Inspect/nameToInstanceCount.md) ↔ Map<String, int> |
| |
| |
| |
| Maps an inspect instance name to the number of instantiations |
| of that inspector. Used to deduplicate requests for |
| similarly named inspectors. |
| _read / write_ |
| |
| |
| |
| |
| |
| ## Static Methods |
| |
| ##### [configure](../package-fuchsia_inspect_inspect/Inspect/configure.md)({int? vmoSizeBytes}) void |
| |
| |
| |
| Optionally configure global settings for inspection. |
| |
| |
| |
| |
| ##### [nextInstanceWithName](../package-fuchsia_inspect_inspect/Inspect/nextInstanceWithName.md)(String name) String |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |