blob: fd1023f8d9288310f58a8c3f33f2fede08ef2bad [file] [log] [blame] [view] [edit]
# `component_index`
Reviewed on: 2019-07-11
`component_index` provides an implementation of the
[`fuchsia.sys.index.ComponentIndex`](fidl/index.fidl) service, which is used on
Fuchsia devices to convert human input into component URLs for developers.
See also: `//src/sys/locate`
## Building
To add this project to your build, append `--with
//src/sys/component_index` to the `fx set` invocation.
## Running
Once included in a build, `component_index` can be accessed via tools such as
`locate` and `run`.
```
$ fx shell locate --help
```
## Testing
Unit tests for `component_index` are available in the `component_index_tests`
package.
```
$ fx test component_index_tests
```
## Source layout
The entrypoint is located in `src/main.rs`, and the fidl service is defined in
`fidl/index.fidl`.