Struct ControllerSynchronousProxy 

pub struct ControllerSynchronousProxy { /* private fields */ }

Implementations

impl ControllerSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<ControllerEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn start( &self, args: StartChildArgs, execution_controller: ServerEnd<ExecutionControllerMarker>, ___deadline: MonotonicInstant, ) -> Result<ControllerStartResult, Error>

Start the component, optionally providing additional handles to be given to the component. Returns INSTANCE_ALREADY_RUNNING if the instance is currently running.

pub fn is_started( &self, ___deadline: MonotonicInstant, ) -> Result<ControllerIsStartedResult, Error>

Returns true if this instance is currently running.

pub fn open_exposed_dir( &self, exposed_dir: ServerEnd<DirectoryMarker>, ___deadline: MonotonicInstant, ) -> Result<ControllerOpenExposedDirResult, Error>

Opens the exposed directory of the controlled component, through which capabilities the component exposed via ComponentDecl.exposes are available, on success.

Binding to the exposed directory requires that the component be resolved, but it will not be started until/unless some capability is requested that requires it to be.

If this component is destroyed, any outstanding connections to exposed_dir will be closed.

Errors:

• INSTANCE_CANNOT_RESOLVE: This component failed to resolve.

pub fn get_exposed_dictionary( &self, ___deadline: MonotonicInstant, ) -> Result<ControllerGetExposedDictionaryResult, Error>

Returns the dictionary containing the component’s exposed capabilities.

pub fn destroy( &self, ___deadline: MonotonicInstant, ) -> Result<ControllerDestroyResult, Error>

Destroys this component. When this method returns, the component is either destroyed or in the case of an error no destruction happened.

Errors:

• ACCESS_DENIED: Destruction of this component is not allowed. Currently, this can happen if the component is a static child of its parent.
• INTERNAL: Something prevented destruction from succeeding – component manager’s logs will contain more detail.

Trait Implementations

impl Debug for ControllerSynchronousProxy

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

Formats the value using the given formatter.

impl From<Channel> for ControllerSynchronousProxy

Available on Fuchsia only.

fn from(value: Channel) -> Self

Converts to this type from the input type.

impl From<ControllerSynchronousProxy> for NullableHandle

Available on Fuchsia only.

fn from(value: ControllerSynchronousProxy) -> Self

Converts to this type from the input type.

impl FromClient for ControllerSynchronousProxy

Available on Fuchsia only.

type Protocol = ControllerMarker

The protocol.

fn from_client(value: ClientEnd<ControllerMarker>) -> Self

Converts from a client.

impl SynchronousProxy for ControllerSynchronousProxy

Available on Fuchsia only.

type Proxy = ControllerProxy

The async proxy for the same protocol.

type Protocol = ControllerMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.