Struct fidl_fuchsia_component::RealmProxy

pub struct RealmProxy { /* private fields */ }

Implementations

impl RealmProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.component/Realm.

pub fn take_event_stream(&self) -> RealmEventStream

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

Panics

Panics if the event stream was already taken.

pub fn open_controller( &self, child: &ChildRef, controller: ServerEnd<ControllerMarker>, ) -> QueryResponseFut<RealmOpenControllerResult, DefaultFuchsiaResourceDialect>

Operate on a child component. See documentation for [Controller].

Errors:

• INVALID_ARGUMENTS: child is not a valid child reference.
• INSTANCE_NOT_FOUND: child does not exist.
• INSTANCE_DIED: This realm no longer exists.

pub fn open_exposed_dir( &self, child: &ChildRef, exposed_dir: ServerEnd<DirectoryMarker>, ) -> QueryResponseFut<RealmOpenExposedDirResult, DefaultFuchsiaResourceDialect>

Opens the exposed directory of a child component instance. When this function successfully returns, exposed_dir is bound to a directory that contains the capabilities which the child exposed to its realm via ComponentDecl.exposes (specified via “expose” declarations in the component’s manifest). The child component will not start as a result of this call. Instead, starting will occur iff the parent binds to one of the capabilities contained within exposed_dir.

exposed_dir is open as long as child exists.

Errors:

• INVALID_ARGUMENTS: child is not a valid child reference.
• INSTANCE_NOT_FOUND: child does not exist.
• INSTANCE_CANNOT_RESOLVE: child’s component declaration failed to resolve.
• INSTANCE_DIED: This realm no longer exists.

pub fn create_child( &self, collection: &CollectionRef, decl: &Child, args: CreateChildArgs, ) -> QueryResponseFut<RealmCreateChildResult, DefaultFuchsiaResourceDialect>

Creates a child component instance dynamically. When this function returns successfully, the instance exists, but it may not be running.

The environment of the child instance is determined by the environment of the collection. decl must not set environment.

If decl.startup == EAGER, or collection.durability == SINGLE_RUN, [CreateChild] will start the component and return once the component is started. Otherwise, [CreateChild] will return immediately after creating the component and will not start or resolve it.

Errors:

• INVALID_ARGUMENTS: collection is not a valid reference or child is not a valid declaration.
• COLLECTION_NOT_FOUND: collection does not exist.
• INSTANCE_ALREADY_EXISTS: decl.name already exists in collection.
• INSTANCE_CANNOT_RESOLVE: child’s component declaration failed to resolve in a SingleRun collection.
• NO_SPACE: Could not allocate storage for the new instance.
• INSTANCE_DIED: This realm no longer exists.

pub fn destroy_child( &self, child: &ChildRef, ) -> QueryResponseFut<RealmDestroyChildResult, DefaultFuchsiaResourceDialect>

Destroys a dynamically-created component instance. When this function returns, the instance is destroyed and has stopped running. However, cleanup of the component’s resources (such as its isolated storage) may happen in the background after this function returns.

Errors:

• INVALID_ARGUMENTS: child is not a valid reference or does not refer to a dynamic instance.
• INSTANCE_NOT_FOUND: child does not exist.
• COLLECTION_NOT_FOUND: collection does not exist.
• INSTANCE_DIED: This realm no longer exists.

pub fn list_children( &self, collection: &CollectionRef, iter: ServerEnd<ChildIteratorMarker>, ) -> QueryResponseFut<RealmListChildrenResult, DefaultFuchsiaResourceDialect>

Returns an iterator that lists all instances in a collection.

NOTE: The results are not guaranteed to be consistent. Instances may be created or destroyed while the iterator is live, but those changes won’t be observed by the iterator after this method returns.

Errors:

• INVALID_ARGUMENTS: collection is not a valid reference or iter does not have ZX_RIGHT_WAIT.
• COLLECTION_NOT_FOUND: collection does not exist.
• INSTANCE_DIED: This realm no longer exists.
• If iter does not have standard channel rights, this function may return ACCESS_DENIED or component manager may close iter.

Trait Implementations

impl Clone for RealmProxy

fn clone(&self) -> RealmProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RealmProxy

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

Formats the value using the given formatter.

impl Proxy for RealmProxy

type Protocol = RealmMarker

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.

impl RealmProxyInterface for RealmProxy

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

fn open_controller( &self, child: &ChildRef, controller: ServerEnd<ControllerMarker>, ) -> Self::OpenControllerResponseFut

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

fn open_exposed_dir( &self, child: &ChildRef, exposed_dir: ServerEnd<DirectoryMarker>, ) -> Self::OpenExposedDirResponseFut

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

fn create_child( &self, collection: &CollectionRef, decl: &Child, args: CreateChildArgs, ) -> Self::CreateChildResponseFut

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

fn destroy_child(&self, child: &ChildRef) -> Self::DestroyChildResponseFut

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

fn list_children( &self, collection: &CollectionRef, iter: ServerEnd<ChildIteratorMarker>, ) -> Self::ListChildrenResponseFut