Enum ManagerRequest

pub enum ManagerRequest {
    GetDriverInfo {
        driver_filter: Vec<String>,
        iterator: ServerEnd<DriverInfoIteratorMarker>,
        control_handle: ManagerControlHandle,
    },
    GetCompositeNodeSpecs {
        name_filter: Option<String>,
        iterator: ServerEnd<CompositeNodeSpecIteratorMarker>,
        control_handle: ManagerControlHandle,
    },
    GetNodeInfo {
        node_filter: Vec<String>,
        iterator: ServerEnd<NodeInfoIteratorMarker>,
        exact_match: bool,
        control_handle: ManagerControlHandle,
    },
    GetCompositeInfo {
        iterator: ServerEnd<CompositeInfoIteratorMarker>,
        control_handle: ManagerControlHandle,
    },
    GetDriverHostInfo {
        iterator: ServerEnd<DriverHostInfoIteratorMarker>,
        control_handle: ManagerControlHandle,
    },
    RestartDriverHosts {
        driver_url: String,
        rematch_flags: RestartRematchFlags,
        responder: ManagerRestartDriverHostsResponder,
    },
    DisableDriver {
        driver_url: String,
        package_hash: Option<String>,
        responder: ManagerDisableDriverResponder,
    },
    EnableDriver {
        driver_url: String,
        package_hash: Option<String>,
        responder: ManagerEnableDriverResponder,
    },
    BindAllUnboundNodes {
        responder: ManagerBindAllUnboundNodesResponder,
    },
    AddTestNode {
        args: TestNodeAddArgs,
        responder: ManagerAddTestNodeResponder,
    },
    RemoveTestNode {
        name: String,
        responder: ManagerRemoveTestNodeResponder,
    },
    WaitForBootup {
        responder: ManagerWaitForBootupResponder,
    },
    RestartWithDictionary {
        moniker: String,
        dictionary: DictionaryRef,
        responder: ManagerRestartWithDictionaryResponder,
    },
    RebindCompositesWithDriver {
        driver_url: String,
        responder: ManagerRebindCompositesWithDriverResponder,
    },
    _UnknownMethod {
        ordinal: u64,
        control_handle: ManagerControlHandle,
        method_type: MethodType,
    },
}

Interface for the driver development manager. This interface should only be used for development and disabled in release builds.

Variants

GetDriverInfo

Returns a list of all drivers that are known to the system. If a |driver_filter| is provided, the returned list will be filtered to only include drivers specified in the filter.

|iterator| is closed with following epitaphs on error: ZX_ERR_NOT_FOUND indicates that there is no driver matching the given path for at least one driver in |driver_filter|. ZX_ERR_BUFFER_TOO_SMALL indicates that the driver’s bind program is longer than the maximum number of instructions (BIND_PROGRAM_INSTRUCTIONS_MAX).

Fields

driver_filter: Vec<String>

iterator: ServerEnd<DriverInfoIteratorMarker>

control_handle: ManagerControlHandle

GetCompositeNodeSpecs

Returns a list of all composite node specs that are known to the system. If a |name_filter| is provided, the returned list will only include 1 spec, the one with that exact name.

|iterator| is closed with following epitaphs on error: ZX_ERR_NOT_FOUND indicates that there are no specs or if a |name_filter| is provided, that there are no specs with that name.

Fields

name_filter: Option<String>

iterator: ServerEnd<CompositeNodeSpecIteratorMarker>

control_handle: ManagerControlHandle

GetNodeInfo

Returns the list of nodes that are running on the system.

If a |node_filter| is provided, the returned list will be filtered to only include nodes specified in the filter. If |exact_match| is true, then the filter must exactly match a node’s topological path; otherwise, it performs a substring match. The list will be empty if no nodes match the filter.

|iterator| is closed with following epitaphs on error: ZX_ERR_BAD_PATH indicates that the given path is not valid. ZX_ERR_BUFFER_TOO_SMALL indicates either that the given path is too long, or that the node has more than the maximum number of properties (PROPERTIES_MAX).

Fields

node_filter: Vec<String>

iterator: ServerEnd<NodeInfoIteratorMarker>

exact_match: bool

control_handle: ManagerControlHandle

GetCompositeInfo

Returns the list of composites in the system. This includes composites that are not yet assembled and added into the node topology.

Fields

iterator: ServerEnd<CompositeInfoIteratorMarker>

control_handle: ManagerControlHandle

GetDriverHostInfo

Returns a list of all driver hosts that are known to the system.

Fields

iterator: ServerEnd<DriverHostInfoIteratorMarker>

control_handle: ManagerControlHandle

RestartDriverHosts

Restarts all driver hosts containing the driver specified by the driver_url, and returns the number of driver hosts that were restarted. The |rematch_flags| will be used to decide for which restarting nodes the existing driver should be bound vs. for which ones the matching process should be performed again.

Fields

driver_url: String

rematch_flags: RestartRematchFlags

responder: ManagerRestartDriverHostsResponder

DisableDriver

Disables the driver with the given driver component url. Disabled drivers will not be considered for matching to nodes. If a |package_hash| is provided, only that specific version of the driver package will be disabled. Otherwise this applies to all existing versions of a driver with the given url. Returns an error ZX_ERR_NOT_FOUND if no drivers were affected.

Fields

driver_url: String

package_hash: Option<String>

responder: ManagerDisableDriverResponder

EnableDriver

Enables the driver with the given driver component url. This is only meant to revert a |DisableDriver| action. Returns an error ZX_ERR_NOT_FOUND if no drivers were affected.

Fields

driver_url: String

package_hash: Option<String>

responder: ManagerEnableDriverResponder

BindAllUnboundNodes

Attempts to bind all unbound nodes in the topology. Returns new successful binds.

Fields

responder: ManagerBindAllUnboundNodesResponder

AddTestNode

Adds test node under the root node.

Fields

args: TestNodeAddArgs

responder: ManagerAddTestNodeResponder

RemoveTestNode

Removes the test node. The node is removed asynchronously and is not guaranteed to be removed by the time this returns.

Fields

name: String

responder: ManagerRemoveTestNodeResponder

WaitForBootup

Waits for bootup to complete.

Fields

responder: ManagerWaitForBootupResponder

RestartWithDictionary

Restarts the driver components bound to the nodes identified in |node_ids|, providing them with the given dictionary. All child nodes are also restarted and provided with this dictionary. This operation is temporary and is reversed by releasing the |release_fence| that is returned.

Fields

moniker: String

dictionary: DictionaryRef

responder: ManagerRestartWithDictionaryResponder

RebindCompositesWithDriver

Rebinds any composites and composite specs that have the given driver_url. This means the spec is rematched with possibly another driver, or none if the only matching driver is disabled, and any active nodes created from this spec are removed and re-bound.

Returns the number of affected composite nodes.

Fields

driver_url: String

responder: ManagerRebindCompositesWithDriverResponder

_UnknownMethod

An interaction was received which does not match any known method.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ordinal: u64

Ordinal of the method that was called.

control_handle: ManagerControlHandle

method_type: MethodType

Implementations

impl ManagerRequest

pub fn into_get_driver_info( self, ) -> Option<(Vec<String>, ServerEnd<DriverInfoIteratorMarker>, ManagerControlHandle)>

pub fn into_get_composite_node_specs( self, ) -> Option<(Option<String>, ServerEnd<CompositeNodeSpecIteratorMarker>, ManagerControlHandle)>

pub fn into_get_node_info( self, ) -> Option<(Vec<String>, ServerEnd<NodeInfoIteratorMarker>, bool, ManagerControlHandle)>

pub fn into_get_composite_info( self, ) -> Option<(ServerEnd<CompositeInfoIteratorMarker>, ManagerControlHandle)>

pub fn into_get_driver_host_info( self, ) -> Option<(ServerEnd<DriverHostInfoIteratorMarker>, ManagerControlHandle)>

pub fn into_restart_driver_hosts( self, ) -> Option<(String, RestartRematchFlags, ManagerRestartDriverHostsResponder)>

pub fn into_disable_driver( self, ) -> Option<(String, Option<String>, ManagerDisableDriverResponder)>

pub fn into_enable_driver( self, ) -> Option<(String, Option<String>, ManagerEnableDriverResponder)>

pub fn into_bind_all_unbound_nodes( self, ) -> Option<ManagerBindAllUnboundNodesResponder>

pub fn into_add_test_node( self, ) -> Option<(TestNodeAddArgs, ManagerAddTestNodeResponder)>

pub fn into_remove_test_node( self, ) -> Option<(String, ManagerRemoveTestNodeResponder)>

pub fn into_wait_for_bootup(self) -> Option<ManagerWaitForBootupResponder>

pub fn into_restart_with_dictionary( self, ) -> Option<(String, DictionaryRef, ManagerRestartWithDictionaryResponder)>

pub fn into_rebind_composites_with_driver( self, ) -> Option<(String, ManagerRebindCompositesWithDriverResponder)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for ManagerRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.