fuchsia.diagnostics.inspect

PROTOCOLS

Reader

Defined in fuchsia.diagnostics.inspect/inspect.fidl

AddSelector

Adds a [fuchsia.diagnostics.inspect/ReaderSelector] to the Inspect instance, which will be used when determining which Inspect data to parse and return. + request selector a [fuchsia.diagnostics.inspect/ReaderSelector] defining a specific component-hierarchy and inspect-tree pattern of interest to the client. * error a [fuchsia.diagnostics.inspect/ReaderError] value indicating how the call failed. - UNIMPLEMENTED_FORMAT means that a selector whose format is not yet supported was provided.

  • INVALID_SELECTOR means that a selector which had an invalid structure was passed in and failed verficiation.

Request

NameType
selector ReaderSelector

Response

NameType
result Reader_AddSelector_Result

ClearSelectors

Removes all previously added ReaderSelectors from the Inspect instance.

Request

NameType

Format

Parses the inspect data of the component hierarchy into a format specified by the [fuchsia.diagnostics.inspect/FormatSettings] struct, dump that formatted string to a VMO, and return a buffer to the VMO.

The inspect data which is parsed is defined both by the static configuration of the service and the ReaderSelectors which are currently added to the instance. If no added ReaderSelectors have been added to the current instance, the default behavior is to parse all Inspect data that the instance has access to.

  • request settings the fuchsia.diagnostics.inspect/FormatSettings that specifies the format of the read Inspect data.
  • response inspect_data_result the fuchsia.mem/Buffer which contains the formatted inspect data.
  • error a [fuchsia.diagnostics.inspect/ReaderError] value indicating how the call failed.
    • IO means that parsing the Inspect VMO or writing the formatted data failed.

Request

NameType
settings FormatSettings

Response

NameType
result Reader_Format_Result

STRUCTS

Reader_AddSelector_Response

generated

NameTypeDescriptionDefault

Reader_Format_Response

generated

NameTypeDescriptionDefault
inspect_data_result fuchsia.mem/Buffer No default

JsonSettings

Defined in fuchsia.diagnostics.inspect/inspect.fidl

NameTypeDescriptionDefault
indent int32 No default

TextSettings

Defined in fuchsia.diagnostics.inspect/inspect.fidl

NameTypeDescriptionDefault
indent int32 No default

Selector

Defined in fuchsia.diagnostics.inspect/selector.fidl

Structured selector containing all required information for the Inspect service to provide specific views into inspect data.

NameTypeDescriptionDefault
component_selector fuchsia.diagnostics/ComponentSelector No default
tree_selector TreeSelector No default

ENUMS

ReaderError

Type: uint32

Defined in fuchsia.diagnostics.inspect/inspect.fidl

Enums describing the potential fail states of the reader service.

NameValueDescription
UNIMPLEMENTED_FORMAT 1
INVALID_SELECTOR 2
IO 3

TABLES

FormatSettings

Defined in fuchsia.diagnostics.inspect/inspect.fidl

OrdinalNameTypeDescription
1 format DisplaySettings

TreeSelector

Defined in fuchsia.diagnostics.inspect/selector.fidl

TreeSelector represents a selection request on a nested structure where each nested node has properties that can be retrieved. The node_path specifies which nodes we search through, and the target_properties specify which properties to look for on the matched nodes.

OrdinalNameTypeDescription
1 node_path vector<fuchsia.diagnostics/PathSelectionNode>[1024]
2 target_properties PropertySelector

UNIONS

Reader_AddSelector_Result

generated

NameTypeDescription
response Reader_AddSelector_Response
err ReaderError

Reader_Format_Result

generated

NameTypeDescription
response Reader_Format_Response
err ReaderError

XUNIONS

DisplaySettings

Defined in fuchsia.diagnostics.inspect/inspect.fidl

Criteria for how to format the selected Inspect data.

NameTypeDescription
json JsonSettings
text TextSettings

ReaderSelector

Defined in fuchsia.diagnostics.inspect/inspect.fidl

Selection criteria for data returned by the Reader service.

NameTypeDescription
structured_selector Selector The reader applies the selection defined by structured_selector to all possible inspect data that it has access to, returning a potential subset, but not superset, of what would be returned by selection using only the system configuration.
string_selector string[1024] The reader parses the string-based selector string_selector into a structured selector and then will apply the selection defined by structured_selector to all possible inspect data that it has access to, returning a potential subset, but not a superset of what would be returned by selection using only the system configuration.

PropertySelector

Defined in fuchsia.diagnostics.inspect/selector.fidl

NameTypeDescription
string_pattern string[1024]
wildcard bool