Modules§
- compat
- Compatibility shims which mimic some API surfaces of the current Rust bindings.
- composite_
node_ manager - device_
address - driver
- node
- node_
controller - node_
property_ key - node_
property_ value - offer
Structs§
- Bind
Rule - Represents a bind rule in a parent specification.
- Bind
Rule2 - Represents a bind rule in a parent specification.
- BusInfo
- Composite
Driver Info - Information for a composite driver.
- Composite
Driver Match - Information for a composite driver that has matched with a composite.
- Composite
Info - Information for a composite that is defined by a composite node spec.
- Composite
Node Manager - The type corresponding to the CompositeNodeManager protocol. Protocol through which board drivers can create composite node specs.
- Composite
Node Spec - Struct that represents a composite node specification.
- Composite
Parent - A parent to a composite that is defined by a composite node spec.
- Devfs
AddArgs - Device
Category - Device categories as provided in the driver’s component manifest.
- Driver
- The type corresponding to the Driver protocol.
This protocol is used by the Driver Framework’s Driver Host to communicate various messages and
lifecycle hooks to the driver. The connection for this protocol is established through the
|DriverRegistration| defined in the
driver_symbolslibrary. - Driver
Info - General information for a driver, used with both composite and normal drivers.
- Driver
Start Args - Arguments for starting a driver.
- Driver
Start Request - Node
- The type corresponding to the Node protocol.
Protocol through which a driver manages a node that it is bound to.
Drivers should maintain their client connection to the node. Dropping
the client connection while the driver is running will cause the
driver framework to remove the driver and node from the topology.
If the driver has set
host_restart_on_crashto “true” in their component manifest, dropping the connection will initiate a restart of the driver host and driver. - Node
AddArgs - Arguments for adding a node.
- Node
AddChild Request - Node
Controller - The type corresponding to the NodeController protocol. Protocol through which a parent node controls one of its children.
- Node
Controller Request Bind Request - Node
Property - Definition of a property for a node. A property is commonly used to match a node to a driver for driver binding.
- Node
Property2 - Node
Property Entry - Contains the node properties that belong to a node.
- Node
Property Entry2 - Contains the node properties that belong to a node.
- Node
Symbol - Definition of a symbol provided by a driver for a node. A symbol is local to a driver host.
- Parent
Spec - Specification for a node that parents the composite node created from the composite node specification.
- Parent
Spec2 - Specification for a node that parents the composite node created from the composite node specification.
- Wire
Bind Rule - The wire type corresponding to
BindRule. - Wire
Bind Rule2 - The wire type corresponding to
BindRule2. - Wire
BusInfo - The wire type corresponding to
BusInfo. - Wire
BusType - The wire type corresponding to
BusType. - Wire
Composite Driver Info - The wire type corresponding to
CompositeDriverInfo. - Wire
Composite Driver Match - The wire type corresponding to
CompositeDriverMatch. - Wire
Composite Info - The wire type corresponding to
CompositeInfo. - Wire
Composite Node Spec - The wire type corresponding to
CompositeNodeSpec. - Wire
Composite Node Spec Error - The wire type corresponding to
CompositeNodeSpecError. - Wire
Composite Parent - The wire type corresponding to
CompositeParent. - Wire
Condition - The wire type corresponding to
Condition. - Wire
Devfs AddArgs - The wire type corresponding to
DevfsAddArgs. - Wire
Device Address - The wire type corresponding to
DeviceAddress. - Wire
Device Address Stability - The wire type corresponding to
DeviceAddressStability. - Wire
Device Category - The wire type corresponding to
DeviceCategory. - Wire
Driver Info - The wire type corresponding to
DriverInfo. - Wire
Driver Package Type - The wire type corresponding to
DriverPackageType. - Wire
Driver Start Args - The wire type corresponding to
DriverStartArgs. - Wire
Driver Start Request - The wire type corresponding to
DriverStartRequest. - Wire
Node AddArgs - The wire type corresponding to
NodeAddArgs. - Wire
Node AddChild Request - The wire type corresponding to
NodeAddChildRequest. - Wire
Node Controller Request Bind Request - The wire type corresponding to
NodeControllerRequestBindRequest. - Wire
Node Error - The wire type corresponding to
NodeError. - Wire
Node Property - The wire type corresponding to
NodeProperty. - Wire
Node Property2 - The wire type corresponding to
NodeProperty2. - Wire
Node Property Entry - The wire type corresponding to
NodePropertyEntry. - Wire
Node Property Entry2 - The wire type corresponding to
NodePropertyEntry2. - Wire
Node Property Key - The wire type corresponding to
NodePropertyKey. - Wire
Node Property Value - The wire type corresponding to
NodePropertyValue. - Wire
Node Symbol - The wire type corresponding to
NodeSymbol. - Wire
Offer - The wire type corresponding to
Offer. - Wire
Optional Device Address - Wire
Optional Node Property Key - Wire
Optional Node Property Value - Wire
Optional Offer - Wire
Parent Spec - The wire type corresponding to
ParentSpec. - Wire
Parent Spec2 - The wire type corresponding to
ParentSpec2.
Enums§
- BusType
- Composite
Node Spec Error - Error codes for the CompositeNodeManager protocol.
- Condition
- Represents a bind rule condition.
- Device
Address - Device
Address Stability - Driver
Package Type - The type of Fuchsia package that a driver component is inside of. More details about the various package categories are available at: https://fuchsia.dev/fuchsia-src/concepts/packages/package#types_of_packages
- Node
Error - Error codes for the Node protocol.
- Node
Property Key - Node
Property Value - Offer
Constants§
- MAX_
DEVICE_ ADDRESS_ ARRAY_ LEN - MAX_
DEVICE_ ADDRESS_ STR_ LEN - MAX_
MODULE_ NAME_ LENGTH - MAX_
NAMESPACE_ COUNT - MAX_
NODE_ NAME_ LENGTH - MAX_
OFFER_ COUNT - MAX_
PROPERTY_ COUNT - MAX_
RESOURCE_ NAME_ LENGTH - MAX_
SYMBOL_ COUNT - MAX_
SYMBOL_ NAME_ LENGTH
Traits§
- Composite
Node Manager Client Handler - A client handler for the CompositeNodeManager protocol.
- Composite
Node Manager Client Sender - A helper trait for the
CompositeNodeManagerclient sender. - Composite
Node Manager Server Handler - A server handler for the CompositeNodeManager protocol.
- Composite
Node Manager Server Sender - A helper trait for the
CompositeNodeManagerserver sender. - Driver
Client Handler - A client handler for the Driver protocol.
- Driver
Client Sender - A helper trait for the
Driverclient sender. - Driver
Server Handler - A server handler for the Driver protocol.
- Driver
Server Sender - A helper trait for the
Driverserver sender. - Node
Client Handler - A client handler for the Node protocol.
- Node
Client Sender - A helper trait for the
Nodeclient sender. - Node
Controller Client Handler - A client handler for the NodeController protocol.
- Node
Controller Client Sender - A helper trait for the
NodeControllerclient sender. - Node
Controller Server Handler - A server handler for the NodeController protocol.
- Node
Controller Server Sender - A helper trait for the
NodeControllerserver sender. - Node
Server Handler - A server handler for the Node protocol.
- Node
Server Sender - A helper trait for the
Nodeserver sender.
Type Aliases§
- Composite
Node Manager AddSpec Response - Driver
Start Response - Node
AddChild Response - Node
Controller Request Bind Response - Node
Name - Node
Offers Vector - Node
Properties - Node
Property Dictionary - Node
Property Dictionary2 - Node
Property KeyString - Node
Property KeyUint - Node
Property Value Bool - Node
Property Value Enum - Node
Property Value String - Node
Property Value Uint - Node
Property Vector - Wire
Composite Node Manager AddSpec Response - The wire type corresponding to
CompositeNodeManagerAddSpecResponse. - Wire
Driver Start Response - The wire type corresponding to
DriverStartResponse. - Wire
Node AddChild Response - The wire type corresponding to
NodeAddChildResponse. - Wire
Node Controller Request Bind Response - The wire type corresponding to
NodeControllerRequestBindResponse. - Wire
Node Name - The wire type corresponding to
NodeName. - Wire
Node Offers Vector - The wire type corresponding to
NodeOffersVector. - Wire
Node Properties - The wire type corresponding to
NodeProperties. - Wire
Node Property Dictionary - The wire type corresponding to
NodePropertyDictionary. - Wire
Node Property Dictionary2 - The wire type corresponding to
NodePropertyDictionary2. - Wire
Node Property KeyString - The wire type corresponding to
NodePropertyKeyString. - Wire
Node Property KeyUint - The wire type corresponding to
NodePropertyKeyUint. - Wire
Node Property Value Bool - The wire type corresponding to
NodePropertyValueBool. - Wire
Node Property Value Enum - The wire type corresponding to
NodePropertyValueEnum. - Wire
Node Property Value String - The wire type corresponding to
NodePropertyValueString. - Wire
Node Property Value Uint - The wire type corresponding to
NodePropertyValueUint. - Wire
Node Property Vector - The wire type corresponding to
NodePropertyVector.