pub struct RealmSynchronousProxy { /* private fields */ }
Implementations§
source§impl RealmSynchronousProxy
impl RealmSynchronousProxy
pub fn new(channel: Channel) -> Self
pub fn into_channel(self) -> Channel
sourcepub fn wait_for_event(
&self,
deadline: MonotonicInstant,
) -> Result<RealmEvent, Error>
pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<RealmEvent, Error>
Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.
sourcepub fn open_controller(
&self,
child: &ChildRef,
controller: ServerEnd<ControllerMarker>,
___deadline: MonotonicInstant,
) -> Result<RealmOpenControllerResult, Error>
pub fn open_controller( &self, child: &ChildRef, controller: ServerEnd<ControllerMarker>, ___deadline: MonotonicInstant, ) -> Result<RealmOpenControllerResult, Error>
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.
sourcepub fn open_exposed_dir(
&self,
child: &ChildRef,
exposed_dir: ServerEnd<DirectoryMarker>,
___deadline: MonotonicInstant,
) -> Result<RealmOpenExposedDirResult, Error>
pub fn open_exposed_dir( &self, child: &ChildRef, exposed_dir: ServerEnd<DirectoryMarker>, ___deadline: MonotonicInstant, ) -> Result<RealmOpenExposedDirResult, Error>
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.
sourcepub fn create_child(
&self,
collection: &CollectionRef,
decl: &Child,
args: CreateChildArgs,
___deadline: MonotonicInstant,
) -> Result<RealmCreateChildResult, Error>
pub fn create_child( &self, collection: &CollectionRef, decl: &Child, args: CreateChildArgs, ___deadline: MonotonicInstant, ) -> Result<RealmCreateChildResult, Error>
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 orchild
is not a valid declaration.COLLECTION_NOT_FOUND
:collection
does not exist.INSTANCE_ALREADY_EXISTS
:decl.name
already exists incollection
.INSTANCE_CANNOT_RESOLVE
:child
’s component declaration failed to resolve in aSingleRun
collection.NO_SPACE
: Could not allocate storage for the new instance.INSTANCE_DIED
: This realm no longer exists.
sourcepub fn destroy_child(
&self,
child: &ChildRef,
___deadline: MonotonicInstant,
) -> Result<RealmDestroyChildResult, Error>
pub fn destroy_child( &self, child: &ChildRef, ___deadline: MonotonicInstant, ) -> Result<RealmDestroyChildResult, Error>
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.
sourcepub fn list_children(
&self,
collection: &CollectionRef,
iter: ServerEnd<ChildIteratorMarker>,
___deadline: MonotonicInstant,
) -> Result<RealmListChildrenResult, Error>
pub fn list_children( &self, collection: &CollectionRef, iter: ServerEnd<ChildIteratorMarker>, ___deadline: MonotonicInstant, ) -> Result<RealmListChildrenResult, Error>
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 oriter
does not haveZX_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 returnACCESS_DENIED
or component manager may closeiter
.
Trait Implementations§
source§impl Debug for RealmSynchronousProxy
impl Debug for RealmSynchronousProxy
source§impl SynchronousProxy for RealmSynchronousProxy
impl SynchronousProxy for RealmSynchronousProxy
§type Proxy = RealmProxy
type Proxy = RealmProxy
§type Protocol = RealmMarker
type Protocol = RealmMarker
Proxy
controls.