Struct fidl_fuchsia_component::ControllerProxy

pub struct ControllerProxy { /* private fields */ }

Implementations

impl ControllerProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.component/Controller.

pub fn take_event_stream(&self) -> ControllerEventStream

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

Panics

Panics if the event stream was already taken.

pub fn start( &self, args: StartChildArgs, execution_controller: ServerEnd<ExecutionControllerMarker>, ) -> QueryResponseFut<ControllerStartResult, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<ControllerIsStartedResult, DefaultFuchsiaResourceDialect>

Returns true if this instance is currently running.

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

Returns the dictionary containing the component’s exposed capabilities.

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

Destroys this component. When this method returns, either:

• Ok was returned, indicating destruction has begun.
• An error was returned, and destruction will not be attempted.

If Ok was returned, destruction will proceed in the background, but it hasn’t necessarily completed yet. When it completes, the framework will close this [Controller] channel.

Errors:

• ACCESS_DENIED: Destruction of this component is not allowed. Currently, this can happen if the component is a static child of its parent.

Trait Implementations

impl Clone for ControllerProxy

fn clone(&self) -> ControllerProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ControllerProxyInterface for ControllerProxy

type StartResponseFut = QueryResponseFut<Result<(), Error>>

fn start( &self, args: StartChildArgs, execution_controller: ServerEnd<ExecutionControllerMarker>, ) -> Self::StartResponseFut

type IsStartedResponseFut = QueryResponseFut<Result<bool, Error>>

fn is_started(&self) -> Self::IsStartedResponseFut

type GetExposedDictionaryResponseFut = QueryResponseFut<Result<DictionaryRef, Error>>

fn get_exposed_dictionary(&self) -> Self::GetExposedDictionaryResponseFut

type DestroyResponseFut = QueryResponseFut<Result<(), Error>>

fn destroy(&self) -> Self::DestroyResponseFut

impl Debug for ControllerProxy

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

Formats the value using the given formatter.

impl Proxy for ControllerProxy

type Protocol = ControllerMarker

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.