Struct ManagerProxy

pub struct ManagerProxy { /* private fields */ }

Implementations

impl ManagerProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.driver.development/Manager.

pub fn take_event_stream(&self) -> ManagerEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn get_driver_info( &self, driver_filter: &[String], iterator: ServerEnd<DriverInfoIteratorMarker>, ) -> Result<(), Error>

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).

pub fn get_composite_node_specs( &self, name_filter: Option<&str>, iterator: ServerEnd<CompositeNodeSpecIteratorMarker>, ) -> Result<(), Error>

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.

pub fn get_node_info( &self, node_filter: &[String], iterator: ServerEnd<NodeInfoIteratorMarker>, exact_match: bool, ) -> Result<(), Error>

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).

pub fn get_composite_info( &self, iterator: ServerEnd<CompositeInfoIteratorMarker>, ) -> Result<(), Error>

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

pub fn get_driver_host_info( &self, iterator: ServerEnd<DriverHostInfoIteratorMarker>, ) -> Result<(), Error>

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

pub fn restart_driver_hosts( &self, driver_url: &str, rematch_flags: RestartRematchFlags, ) -> QueryResponseFut<ManagerRestartDriverHostsResult, DefaultFuchsiaResourceDialect>

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.

pub fn disable_driver( &self, driver_url: &str, package_hash: Option<&str>, ) -> QueryResponseFut<ManagerDisableDriverResult, DefaultFuchsiaResourceDialect>

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.

pub fn enable_driver( &self, driver_url: &str, package_hash: Option<&str>, ) -> QueryResponseFut<ManagerEnableDriverResult, DefaultFuchsiaResourceDialect>

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.

pub fn bind_all_unbound_nodes( &self, ) -> QueryResponseFut<ManagerBindAllUnboundNodesResult, DefaultFuchsiaResourceDialect>

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

pub fn add_test_node( &self, args: &TestNodeAddArgs, ) -> QueryResponseFut<ManagerAddTestNodeResult, DefaultFuchsiaResourceDialect>

Adds test node under the root node.

pub fn remove_test_node( &self, name: &str, ) -> QueryResponseFut<ManagerRemoveTestNodeResult, DefaultFuchsiaResourceDialect>

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

pub fn wait_for_bootup( &self, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Waits for bootup to complete.

pub fn restart_with_dictionary( &self, moniker: &str, dictionary: DictionaryRef, ) -> QueryResponseFut<ManagerRestartWithDictionaryResult, DefaultFuchsiaResourceDialect>

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.

pub fn rebind_composites_with_driver( &self, driver_url: &str, ) -> QueryResponseFut<ManagerRebindCompositesWithDriverResult, DefaultFuchsiaResourceDialect>

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.

Trait Implementations

impl Clone for ManagerProxy

fn clone(&self) -> ManagerProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ManagerProxy

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

Formats the value using the given formatter.

impl ManagerProxyInterface for ManagerProxy

type RestartDriverHostsResponseFut = QueryResponseFut<Result<u32, i32>>

type DisableDriverResponseFut = QueryResponseFut<Result<(), i32>>

type EnableDriverResponseFut = QueryResponseFut<Result<(), i32>>

type BindAllUnboundNodesResponseFut = QueryResponseFut<Result<Vec<NodeBindingInfo>, i32>>

type AddTestNodeResponseFut = QueryResponseFut<Result<(), NodeError>>

type RemoveTestNodeResponseFut = QueryResponseFut<Result<(), i32>>

type WaitForBootupResponseFut = QueryResponseFut<()>

type RestartWithDictionaryResponseFut = QueryResponseFut<Result<EventPair, i32>>

type RebindCompositesWithDriverResponseFut = QueryResponseFut<Result<u32, i32>>

fn get_driver_info( &self, driver_filter: &[String], iterator: ServerEnd<DriverInfoIteratorMarker>, ) -> Result<(), Error>

fn get_composite_node_specs( &self, name_filter: Option<&str>, iterator: ServerEnd<CompositeNodeSpecIteratorMarker>, ) -> Result<(), Error>

fn get_node_info( &self, node_filter: &[String], iterator: ServerEnd<NodeInfoIteratorMarker>, exact_match: bool, ) -> Result<(), Error>

fn get_composite_info( &self, iterator: ServerEnd<CompositeInfoIteratorMarker>, ) -> Result<(), Error>

fn get_driver_host_info( &self, iterator: ServerEnd<DriverHostInfoIteratorMarker>, ) -> Result<(), Error>

fn restart_driver_hosts( &self, driver_url: &str, rematch_flags: RestartRematchFlags, ) -> Self::RestartDriverHostsResponseFut

fn disable_driver( &self, driver_url: &str, package_hash: Option<&str>, ) -> Self::DisableDriverResponseFut

fn enable_driver( &self, driver_url: &str, package_hash: Option<&str>, ) -> Self::EnableDriverResponseFut

fn bind_all_unbound_nodes(&self) -> Self::BindAllUnboundNodesResponseFut

fn add_test_node(&self, args: &TestNodeAddArgs) -> Self::AddTestNodeResponseFut

fn remove_test_node(&self, name: &str) -> Self::RemoveTestNodeResponseFut

fn wait_for_bootup(&self) -> Self::WaitForBootupResponseFut

fn restart_with_dictionary( &self, moniker: &str, dictionary: DictionaryRef, ) -> Self::RestartWithDictionaryResponseFut

fn rebind_composites_with_driver( &self, driver_url: &str, ) -> Self::RebindCompositesWithDriverResponseFut

impl Proxy for ManagerProxy

type Protocol = ManagerMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.