Modules§
- binder
- child_
iterator - compat
- Compatibility shims which mimic some API surfaces of the current Rust bindings.
- controller
- event_
payload - event_
stream - execution_
controller - introspector
- namespace
- realm
- storage_
admin - storage_
iterator
Structs§
- Binder
- The type corresponding to the Binder protocol. A framework-provided protocol that allows components that use it to bind to the component that exposes it. The act of connecting to this protocol will trigger the bind. Thus, this protocol contains no methods. For more details on binding, see https://fuchsia.dev/fuchsia-src/concepts/components/v2/lifecycle#binding.
- Capability
Requested Payload - Payload for CapabilityRequested events
- Child
Iterator - The type corresponding to the ChildIterator protocol. A protocol to iterate over the list of children in a realm.
- Child
Iterator Next Response - Controller
- The type corresponding to the Controller protocol. A protocol used to operate on a component.
- Controller
GetExposed Dictionary Response - Controller
IsStarted Response - Controller
Start Request - Create
Child Args - Debug
Started Payload - Payload for DebugStarted events.
- Destroyed
Payload - Payload for Destroyed events.
- Discovered
Payload - Payload for Discovered events.
- Event
- Contains all information about a single event
- Event
Header - A head providing metadata about a target component instance.
- Event
Stream - The type corresponding to the EventStream protocol. Listener for events on the component hierarchy. Can’t be used outside of the platform.
- Event
Stream GetNext Response - Execution
Controller - The type corresponding to the ExecutionController protocol.
- Execution
Controller OnStop Request - Introspector
- The type corresponding to the Introspector protocol. A protocol used by a component instance to obtain information about components in its own realm.
- Introspector
GetMoniker Request - Introspector
GetMoniker Response - Namespace
- The type corresponding to the Namespace protocol. Protocol for performing namespace operations.
- Namespace
Create Request - Namespace
Create Response - Namespace
Entry - A single component namespace entry, which describes a namespace mount point
(
path) and the directory backing it (directory). This type is usually composed inside a vector. SeeComponentStartInfo.nsfor more details. - Namespace
Input Entry - Purged
Payload - Payload for Purged events.
- Realm
- The type corresponding to the Realm protocol. A protocol used by a component instance to manage its own realm, such as for binding to its children.
- Realm
Create Child Request - Realm
Destroy Child Request - Realm
GetChild Output Dictionary Request - Realm
GetChild Output Dictionary Response - Realm
GetResolved Info Response - Realm
List Children Request - Realm
Open Controller Request - Realm
Open Exposed DirRequest - Resolved
Payload - Payload for Resolved events.
- Start
Child Args - Started
Payload - Payload for Started events.
- Stopped
Payload - Payload for Stopped events.
- Storage
Admin - The type corresponding to the StorageAdmin protocol.
- Storage
Admin Delete Component Storage Request - Storage
Admin List Storage InRealm Request - Storage
Admin Open Component Storage ById Request - Storage
Admin Open Storage Request - Storage
Iterator - The type corresponding to the StorageIterator protocol. An iterator protocol for returning a set of components using a storage capability. See |StorageAdmin.ListStorageInRealm| for more information.
- Storage
Iterator Next Response - Storage
Status - Metadata about status of the storage
- Unresolved
Payload - Payload for Unresolved events.
- Wire
Capability Requested Payload - The wire type corresponding to
CapabilityRequestedPayload. - Wire
Child Iterator Next Response - The wire type corresponding to
ChildIteratorNextResponse. - Wire
Controller GetExposed Dictionary Response - The wire type corresponding to
ControllerGetExposedDictionaryResponse. - Wire
Controller IsStarted Response - The wire type corresponding to
ControllerIsStartedResponse. - Wire
Controller Start Request - The wire type corresponding to
ControllerStartRequest. - Wire
Create Child Args - The wire type corresponding to
CreateChildArgs. - Wire
Debug Started Payload - The wire type corresponding to
DebugStartedPayload. - Wire
Deletion Error - The wire type corresponding to
DeletionError. - Wire
Destroyed Payload - The wire type corresponding to
DestroyedPayload. - Wire
Discovered Payload - The wire type corresponding to
DiscoveredPayload. - Wire
Error - The wire type corresponding to
Error. - Wire
Event - The wire type corresponding to
Event. - Wire
Event Header - The wire type corresponding to
EventHeader. - Wire
Event Payload - The wire type corresponding to
EventPayload. - Wire
Event Stream GetNext Response - The wire type corresponding to
EventStreamGetNextResponse. - Wire
Event Type - The wire type corresponding to
EventType. - Wire
Execution Controller OnStop Request - The wire type corresponding to
ExecutionControllerOnStopRequest. - Wire
Introspector GetMoniker Request - The wire type corresponding to
IntrospectorGetMonikerRequest. - Wire
Introspector GetMoniker Response - The wire type corresponding to
IntrospectorGetMonikerResponse. - Wire
Namespace Create Request - The wire type corresponding to
NamespaceCreateRequest. - Wire
Namespace Create Response - The wire type corresponding to
NamespaceCreateResponse. - Wire
Namespace Entry - The wire type corresponding to
NamespaceEntry. - Wire
Namespace Error - The wire type corresponding to
NamespaceError. - Wire
Namespace Input Entry - The wire type corresponding to
NamespaceInputEntry. - Wire
Optional Event Payload - Wire
Purged Payload - The wire type corresponding to
PurgedPayload. - Wire
Realm Create Child Request - The wire type corresponding to
RealmCreateChildRequest. - Wire
Realm Destroy Child Request - The wire type corresponding to
RealmDestroyChildRequest. - Wire
Realm GetChild Output Dictionary Request - The wire type corresponding to
RealmGetChildOutputDictionaryRequest. - Wire
Realm GetChild Output Dictionary Response - The wire type corresponding to
RealmGetChildOutputDictionaryResponse. - Wire
Realm GetResolved Info Response - The wire type corresponding to
RealmGetResolvedInfoResponse. - Wire
Realm List Children Request - The wire type corresponding to
RealmListChildrenRequest. - Wire
Realm Open Controller Request - The wire type corresponding to
RealmOpenControllerRequest. - Wire
Realm Open Exposed DirRequest - The wire type corresponding to
RealmOpenExposedDirRequest. - Wire
Resolved Payload - The wire type corresponding to
ResolvedPayload. - Wire
Start Child Args - The wire type corresponding to
StartChildArgs. - Wire
Started Payload - The wire type corresponding to
StartedPayload. - Wire
Status Error - The wire type corresponding to
StatusError. - Wire
Stopped Payload - The wire type corresponding to
StoppedPayload. - Wire
Storage Admin Delete Component Storage Request - The wire type corresponding to
StorageAdminDeleteComponentStorageRequest. - Wire
Storage Admin List Storage InRealm Request - The wire type corresponding to
StorageAdminListStorageInRealmRequest. - Wire
Storage Admin Open Component Storage ById Request - The wire type corresponding to
StorageAdminOpenComponentStorageByIdRequest. - Wire
Storage Admin Open Storage Request - The wire type corresponding to
StorageAdminOpenStorageRequest. - Wire
Storage Iterator Next Response - The wire type corresponding to
StorageIteratorNextResponse. - Wire
Storage Status - The wire type corresponding to
StorageStatus. - Wire
Unresolved Payload - The wire type corresponding to
UnresolvedPayload.
Enums§
- Deletion
Error - Error
- Standard error codes for component framework protocols.
- Event
Payload - Encapsulates additional data/protocols for some event types.
- Event
Type - These EventTypes are used for the EventStream protocol. They are FIDL versions of the EventType enum in hooks.rs and have the same meaning.
- Namespace
Error - Error returned from methods in
Namespace. - Status
Error
Constants§
- MAX_
CAPABILITY_ ID_ LENGTH - The maximum string length of a capability ID. This value is currently set arbitrarily.
- MAX_
CHILD_ COUNT - The maximum number of children that the a call
ChildIterator.Nextcan return. Note, this is not a limit on the number of children that can be added to a component. This is merely a limit for a single invocation of theNextmethod. - MAX_
CHILD_ NAME_ LENGTH - MAX_
DYNAMIC_ OFFER_ COUNT - The maximum number of dynamic offers that can target a created component.
- MAX_
ERROR_ DESCRIPTION_ LENGTH - The maximum string length of an error description.
- MAX_
HANDLE_ COUNT - The maximum number of handles that can be passed to a created component.
- MAX_
MONIKER_ LENGTH - MAX_
NAMESPACE_ COUNT - MAX_
NAME_ LENGTH - MAX_
NUM_ EVENTS_ RECEIVED - The maximum number of events that a receiver can listen to.
- MAX_
PATH_ LENGTH - MAX_
STORAGE_ ID_ LENGTH - The maximum length of a storage instance ID. A storage instance ID is a 256-bit UUID, which when encoded in hex notation is 64 characters long.
- MAX_
SUBSCRIPTION_ REQUESTS - The maximum number of requests per event subscription.
- MAX_
URL_ SCHEME_ LENGTH
Traits§
- Binder
Client Handler - A client handler for the Binder protocol.
- Binder
Server Handler - A server handler for the Binder protocol.
- Child
Iterator Client Handler - A client handler for the ChildIterator protocol.
- Child
Iterator Server Handler - A server handler for the ChildIterator protocol.
- Controller
Client Handler - A client handler for the Controller protocol.
- Controller
Server Handler - A server handler for the Controller protocol.
- Event
Stream Client Handler - A client handler for the EventStream protocol.
- Event
Stream Server Handler - A server handler for the EventStream protocol.
- Execution
Controller Client Handler - A client handler for the ExecutionController protocol.
- Execution
Controller Server Handler - A server handler for the ExecutionController protocol.
- Introspector
Client Handler - A client handler for the Introspector protocol.
- Introspector
Server Handler - A server handler for the Introspector protocol.
- Namespace
Client Handler - A client handler for the Namespace protocol.
- Namespace
Server Handler - A server handler for the Namespace protocol.
- Realm
Client Handler - A client handler for the Realm protocol.
- Realm
Server Handler - A server handler for the Realm protocol.
- Storage
Admin Client Handler - A client handler for the StorageAdmin protocol.
- Storage
Admin Server Handler - A server handler for the StorageAdmin protocol.
- Storage
Iterator Client Handler - A client handler for the StorageIterator protocol.
- Storage
Iterator Server Handler - A server handler for the StorageIterator protocol.
Type Aliases§
- Child
Name - Controller
Destroy Response - Controller
Start Response - Name
- Realm
Create Child Response - Realm
Destroy Child Response - Realm
List Children Response - Realm
Open Controller Response - Realm
Open Exposed DirResponse - Storage
Admin Delete AllStorage Contents Response - Storage
Admin Delete Component Storage Response - Storage
Admin List Storage InRealm Response - Storage
Admin Open Component Storage ById Response - Storage
Admin Open Storage Response - UrlScheme
- Wire
Child Name - The wire type corresponding to
ChildName. - Wire
Controller Destroy Response - The wire type corresponding to
ControllerDestroyResponse. - Wire
Controller Start Response - The wire type corresponding to
ControllerStartResponse. - Wire
Name - The wire type corresponding to
Name. - Wire
Realm Create Child Response - The wire type corresponding to
RealmCreateChildResponse. - Wire
Realm Destroy Child Response - The wire type corresponding to
RealmDestroyChildResponse. - Wire
Realm List Children Response - The wire type corresponding to
RealmListChildrenResponse. - Wire
Realm Open Controller Response - The wire type corresponding to
RealmOpenControllerResponse. - Wire
Realm Open Exposed DirResponse - The wire type corresponding to
RealmOpenExposedDirResponse. - Wire
Storage Admin Delete AllStorage Contents Response - The wire type corresponding to
StorageAdminDeleteAllStorageContentsResponse. - Wire
Storage Admin Delete Component Storage Response - The wire type corresponding to
StorageAdminDeleteComponentStorageResponse. - Wire
Storage Admin List Storage InRealm Response - The wire type corresponding to
StorageAdminListStorageInRealmResponse. - Wire
Storage Admin Open Component Storage ById Response - The wire type corresponding to
StorageAdminOpenComponentStorageByIdResponse. - Wire
Storage Admin Open Storage Response - The wire type corresponding to
StorageAdminOpenStorageResponse. - Wire
UrlScheme - The wire type corresponding to
UrlScheme.