Struct fidl_fuchsia_driver_development::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 restart_driver_hosts( &self, driver_url: &str, rematch_flags: RestartRematchFlags ) -> QueryResponseFut<ManagerRestartDriverHostsResult>

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>

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>

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>

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

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

Adds test node under the root node.

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

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

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

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>

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

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

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

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

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

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

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

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

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

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

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

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

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.