inspect

Namespaces

Enumerations

enum class ArrayDisplayFormat : uint8_t

Name	Value	Comments
kFlat	0	The array should be displayed as a flat list of numeric types.
kLinearHistogram	1	The array consists of parameters and buckets for a linear histogram.
kExponentialHistogram	2	The array consists of parameters and buckets for an exponential histogram.

Describes how an array of values should be displayed.

Defined at line 19 of file ../../zircon/system/ulib/inspect/include/lib/inspect/cpp/hierarchy.h

enum LinkDisposition

Name	Value	Comments
kChild	0	Include the linked Tree as a child of the parent node.
kInline	1	Inline all children of the linked Tree's root as children of the parent node.

The disposition for a LinkValue describes how its contents should be included in the parent node.

Defined at line 226 of file ../../zircon/system/ulib/inspect/include/lib/inspect/cpp/hierarchy.h

enum class PropertyFormat : uint8_t

Name	Value
kInvalid	0
kInt	1
kUint	2
kDouble	3
kIntArray	4
kUintArray	5
kDoubleArray	6
kString	7
kBytes	8
kBool	9
kStringArray	10

Describes the format of a parsed property.

Defined at line 250 of file ../../zircon/system/ulib/inspect/include/lib/inspect/cpp/hierarchy.h

enum class MissingValueReason

Name	Value	Comments
kLinkNotFound	1	A referenced hierarchy in a link was not found.
kLinkHierarchyParseFailure	2	A linked hierarchy at this location could not be parsed successfully.
kLinkInvalid	3	A link we attempted to follow was not properly formatted, or its format is not known to this reader.

Defined at line 365 of file ../../zircon/system/ulib/inspect/include/lib/inspect/cpp/hierarchy.h

Records

Functions

```
fpromise::result<Hierarchy> ReadFromVmo (const zx::vmo & vmo)
```
Construct a new Hierarchy by synchronously reading nodes out of

the given VMO.

Defined at line 622 of file ../../zircon/system/ulib/inspect/reader.cc
```
void PrintTo (const PropertyValue & property, std::ostream * os)
```
Printers for inspect types.

Defined at line 14 of file ../../sdk/lib/inspect/testing/cpp/inspect.cc
```
void PrintTo (const NodeValue & node, std::ostream * os)
```
Defined at line 55 of file ../../sdk/lib/inspect/testing/cpp/inspect.cc
```
fpromise::result<Hierarchy> ReadFromSnapshot (Snapshot snapshot)
```
Construct a new Hierarchy by synchronously reading nodes out of the

given VMO Snapshot.

Defined at line 617 of file ../../zircon/system/ulib/inspect/reader.cc
```
void PrintTo (const Hierarchy & hierarchy, std::ostream * os)
```
Printer for Hierarchy wrapper.

Defined at line 60 of file ../../sdk/lib/inspect/testing/cpp/inspect.cc
```
fpromise::result<Hierarchy> ReadFromBuffer (std::vector<uint8_t> buffer)
```
Construct a new Hierarchy by synchronously reading nodes out of the

contents of the given buffer.

Defined at line 630 of file ../../zircon/system/ulib/inspect/reader.cc
```
void PrintAll (const Hierarchy & hierarchy, std::ostream * os)
```
Prints all nodes and properties in the Hierarchy.

It can be used for debugging, e.g., PrintAll(hierarchy,

&std

::cout);

Defined at line 65 of file ../../sdk/lib/inspect/testing/cpp/inspect.cc
```
fpromise::promise<Hierarchy> ReadFromInspector (Inspector insp)
```
Construct a new Hierarchy by reading nodes out of the given Inspector, including

all linked hierarchies.

Defined at line 639 of file ../../zircon/system/ulib/inspect/reader.cc
```
void PublishVmo (async_dispatcher_t * dispatcher, zx::vmo vmo, VmoOptions opts)
```
Publish a VMO according to `opts`.

Defined at line 26 of file ../../sdk/lib/inspect/component/cpp/component.cc