inspect

Summary

Enumerations

ArrayDisplayFormat{
  kFlat,
  kLinearHistogram,
  kExponentialHistogram
}
enum
LinkDisposition{
  kChild = 0,
  kInline = 1
}
enum
MissingValueReason{
  kLinkNotFound = 1,
  kLinkHierarchyParseFailure = 2,
  kLinkInvalid = 3
}
enum
PropertyFormat{
  kInvalid = 0,
  kInt = 1,
  kUint = 2,
  kDouble = 3,
  kIntArray = 4,
  kUintArray = 5,
  kDoubleArray = 6,
  kString = 7,
  kBytes = 8,
  kBool = 9,
  kStringArray = 10
}
enum

Typedefs

AtomicUpdateCallbackFn using
fit::function< void(Node &)>
BoolProperty using
internal::Property< bool >
BoolPropertyValue using
internal::Value< bool, static_cast< size_t >(PropertyFormat::kBool)>
BorrowedStringValue using
ByteVectorProperty using
internal::Property< std::vector< uint8_t >>
ByteVectorPropertyValue using
internal::Value< std::vector< uint8_t >, static_cast< size_t >(PropertyFormat::kBytes)>
DoubleArray using
internal::ArrayValue< double >
DoubleArrayValue using
internal::Array< double, static_cast< size_t >(PropertyFormat::kDoubleArray)>
DoubleProperty using
internal::NumericProperty< double >
DoublePropertyValue using
internal::Value< double, static_cast< size_t >(PropertyFormat::kDouble)>
ExponentialDoubleHistogram using
internal::ExponentialHistogram< double >
ExponentialIntHistogram using
internal::ExponentialHistogram< int64_t >
ExponentialUintHistogram using
internal::ExponentialHistogram< uint64_t >
IntArray using
internal::ArrayValue< int64_t >
IntArrayValue using
internal::Array< int64_t, static_cast< size_t >(PropertyFormat::kIntArray)>
IntProperty using
internal::NumericProperty< int64_t >
IntPropertyValue using
internal::Value< int64_t, static_cast< size_t >(PropertyFormat::kInt)>
LazyNodeCallbackFn using
LinearDoubleHistogram using
internal::LinearHistogram< double >
LinearIntHistogram using
internal::LinearHistogram< int64_t >
LinearUintHistogram using
internal::LinearHistogram< uint64_t >
PropertyValue using
internal::NamedValue< cpp17::variant< cpp17::monostate, IntPropertyValue, UintPropertyValue, DoublePropertyValue, IntArrayValue, UintArrayValue, DoubleArrayValue, StringPropertyValue, ByteVectorPropertyValue, BoolPropertyValue, StringArrayValue >, PropertyFormat >
RecordChildCallbackFn using
fit::function< void(Node &)>
StringArray using
internal::ArrayValue< BorrowedStringValue >
StringArrayValue using
internal::Array< std::string, static_cast< size_t >(PropertyFormat::kStringArray)>
StringProperty using
internal::Property< std::string >
StringPropertyValue using
internal::Value< std::string, static_cast< size_t >(PropertyFormat::kString)>
UintArray using
internal::ArrayValue< uint64_t >
UintArrayValue using
internal::Array< uint64_t, static_cast< size_t >(PropertyFormat::kUintArray)>
UintProperty using
internal::NumericProperty< uint64_t >
UintPropertyValue using
internal::Value< uint64_t, static_cast< size_t >(PropertyFormat::kUint)>

Functions

MakeTreeHandler(const inspect::Inspector *inspector, async_dispatcher_t *dispatcher, TreeHandlerSettings settings)
fidl::InterfaceRequestHandler< fuchsia::inspect::Tree >
Returns a handler for fuchsia.inspect.Tree connections on the given Inspector.
ReadAllChildNames(fuchsia::inspect::TreeNameIteratorPtr iterator)
fpromise::promise< std::vector< std::string > >
Read all of the child names from a TreeNameIterator into a vector.
ReadFromBuffer(std::vector< uint8_t > buffer)
ReadFromInspector(Inspector insp)
ReadFromSnapshot(Snapshot snapshot)
ReadFromTree(fuchsia::inspect::TreePtr tree)
Read a full inspect::Hierarchy from a fuchsia.inspect.Tree.
ReadFromVmo(const zx::vmo & vmo)

Classes

inspect::BackingBuffer
inspect::Hierarchy
inspect::Inspector
inspect::LazyNode
inspect::Link
inspect::LinkValue
inspect::Node
inspect::NodeHealth
inspect::NodeValue
inspect::Snapshot
inspect::StringReference
inspect::TreeServerSendPreference

TreeServerSendPreference describes how the VMO should be served.

inspect::ValueList

Structs

inspect::InspectSettings
inspect::InspectStats
inspect::MissingValue
inspect::TreeHandlerSettings

Enumerations

ArrayDisplayFormat

 ArrayDisplayFormat

LinkDisposition

 LinkDisposition
Properties
kChild
kInline

MissingValueReason

 MissingValueReason

Typedefs

AtomicUpdateCallbackFn

fit::function< void(Node &)> AtomicUpdateCallbackFn

BoolProperty

internal::Property< bool > BoolProperty

BoolPropertyValue

internal::Value< bool, static_cast< size_t >(PropertyFormat::kBool)> BoolPropertyValue

BorrowedStringValue

cpp17::variant< cpp17::string_view, StringReference > BorrowedStringValue

ByteVectorProperty

internal::Property< std::vector< uint8_t >> ByteVectorProperty

ByteVectorPropertyValue

internal::Value< std::vector< uint8_t >, static_cast< size_t >(PropertyFormat::kBytes)> ByteVectorPropertyValue

DoubleArray

internal::ArrayValue< double > DoubleArray

DoubleArrayValue

internal::Array< double, static_cast< size_t >(PropertyFormat::kDoubleArray)> DoubleArrayValue

DoubleProperty

internal::NumericProperty< double > DoubleProperty

DoublePropertyValue

internal::Value< double, static_cast< size_t >(PropertyFormat::kDouble)> DoublePropertyValue

ExponentialDoubleHistogram

internal::ExponentialHistogram< double > ExponentialDoubleHistogram

ExponentialIntHistogram

internal::ExponentialHistogram< int64_t > ExponentialIntHistogram

ExponentialUintHistogram

internal::ExponentialHistogram< uint64_t > ExponentialUintHistogram

IntArray

internal::ArrayValue< int64_t > IntArray

IntArrayValue

internal::Array< int64_t, static_cast< size_t >(PropertyFormat::kIntArray)> IntArrayValue

IntProperty

internal::NumericProperty< int64_t > IntProperty

IntPropertyValue

internal::Value< int64_t, static_cast< size_t >(PropertyFormat::kInt)> IntPropertyValue

LazyNodeCallbackFn

fit::function< fpromise::promise< Inspector >()> LazyNodeCallbackFn

LinearDoubleHistogram

internal::LinearHistogram< double > LinearDoubleHistogram

LinearIntHistogram

internal::LinearHistogram< int64_t > LinearIntHistogram

LinearUintHistogram

internal::LinearHistogram< uint64_t > LinearUintHistogram

PropertyValue

internal::NamedValue< cpp17::variant< cpp17::monostate, IntPropertyValue, UintPropertyValue, DoublePropertyValue, IntArrayValue, UintArrayValue, DoubleArrayValue, StringPropertyValue, ByteVectorPropertyValue, BoolPropertyValue, StringArrayValue >, PropertyFormat > PropertyValue

RecordChildCallbackFn

fit::function< void(Node &)> RecordChildCallbackFn

StringArray

internal::ArrayValue< BorrowedStringValue > StringArray

StringArrayValue

internal::Array< std::string, static_cast< size_t >(PropertyFormat::kStringArray)> StringArrayValue

StringProperty

internal::Property< std::string > StringProperty

StringPropertyValue

internal::Value< std::string, static_cast< size_t >(PropertyFormat::kString)> StringPropertyValue

UintArray

internal::ArrayValue< uint64_t > UintArray

UintArrayValue

internal::Array< uint64_t, static_cast< size_t >(PropertyFormat::kUintArray)> UintArrayValue

UintProperty

internal::NumericProperty< uint64_t > UintProperty

UintPropertyValue

internal::Value< uint64_t, static_cast< size_t >(PropertyFormat::kUint)> UintPropertyValue

Functions

MakeTreeHandler

fidl::InterfaceRequestHandler< fuchsia::inspect::Tree > MakeTreeHandler(
  const inspect::Inspector *inspector,
  async_dispatcher_t *dispatcher,
  TreeHandlerSettings settings
)

Returns a handler for fuchsia.inspect.Tree connections on the given Inspector.

This is meant to be used to construct a vfs::ServiceNode to serve the given Inspector as a fuchsia.inspect.Tree.

ReadAllChildNames

fpromise::promise< std::vector< std::string > > ReadAllChildNames(
  fuchsia::inspect::TreeNameIteratorPtr iterator
)

Read all of the child names from a TreeNameIterator into a vector.

This function continually calls GetNext on the iterator until all child names have been returned.

Returns a promise for the vector of child names names.

ReadFromBuffer

fpromise::result< Hierarchy > ReadFromBuffer(
  std::vector< uint8_t > buffer
)

ReadFromInspector

fpromise::promise< Hierarchy > ReadFromInspector(
  Inspector insp
)

ReadFromSnapshot

fpromise::result< Hierarchy > ReadFromSnapshot(
  Snapshot snapshot
)

ReadFromTree

fpromise::promise< Hierarchy > ReadFromTree(
  fuchsia::inspect::TreePtr tree
)

Read a full inspect::Hierarchy from a fuchsia.inspect.Tree.

fuchsia.inspect.Tree provides lookup support for Link nodes stored in a hierarchy. This function uses the protocol to lookup linked data as needed to create a complete view of the entire tree, including dynamically generated subtrees.

Returns a promise for the hierarchy parsed from the Tree.

ReadFromVmo

fpromise::result< Hierarchy > ReadFromVmo(
  const zx::vmo & vmo
)