Trait RealmServerHandler

pub trait RealmServerHandler<___T: Transport = Channel> {
    // Required methods
    fn open_controller(
        &mut self,
        sender: &ServerSender<Realm, ___T>,
        request: Request<OpenController, ___T>,
        responder: Responder<OpenController>,
    ) -> impl Future<Output = ()> + Send;
    fn open_exposed_dir(
        &mut self,
        sender: &ServerSender<Realm, ___T>,
        request: Request<OpenExposedDir, ___T>,
        responder: Responder<OpenExposedDir>,
    ) -> impl Future<Output = ()> + Send;
    fn create_child(
        &mut self,
        sender: &ServerSender<Realm, ___T>,
        request: Request<CreateChild, ___T>,
        responder: Responder<CreateChild>,
    ) -> impl Future<Output = ()> + Send;
    fn destroy_child(
        &mut self,
        sender: &ServerSender<Realm, ___T>,
        request: Request<DestroyChild, ___T>,
        responder: Responder<DestroyChild>,
    ) -> impl Future<Output = ()> + Send;
    fn list_children(
        &mut self,
        sender: &ServerSender<Realm, ___T>,
        request: Request<ListChildren, ___T>,
        responder: Responder<ListChildren>,
    ) -> impl Future<Output = ()> + Send;
    fn get_resolved_info(
        &mut self,
        sender: &ServerSender<Realm, ___T>,
        responder: Responder<GetResolvedInfo>,
    ) -> impl Future<Output = ()> + Send;
    fn get_child_output_dictionary(
        &mut self,
        sender: &ServerSender<Realm, ___T>,
        request: Request<GetChildOutputDictionary, ___T>,
        responder: Responder<GetChildOutputDictionary>,
    ) -> impl Future<Output = ()> + Send;
}

A server handler for the Realm protocol.

See Realm for more details.

Required Methods

fn open_controller( &mut self, sender: &ServerSender<Realm, ___T>, request: Request<OpenController, ___T>, responder: Responder<OpenController>, ) -> impl Future<Output = ()> + Send

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.

fn open_exposed_dir( &mut self, sender: &ServerSender<Realm, ___T>, request: Request<OpenExposedDir, ___T>, responder: Responder<OpenExposedDir>, ) -> impl Future<Output = ()> + Send

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.

fn create_child( &mut self, sender: &ServerSender<Realm, ___T>, request: Request<CreateChild, ___T>, responder: Responder<CreateChild>, ) -> impl Future<Output = ()> + Send

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.

fn destroy_child( &mut self, sender: &ServerSender<Realm, ___T>, request: Request<DestroyChild, ___T>, responder: Responder<DestroyChild>, ) -> impl Future<Output = ()> + Send

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.

fn list_children( &mut self, sender: &ServerSender<Realm, ___T>, request: Request<ListChildren, ___T>, responder: Responder<ListChildren>, ) -> impl Future<Output = ()> + Send

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.

fn get_resolved_info( &mut self, sender: &ServerSender<Realm, ___T>, responder: Responder<GetResolvedInfo>, ) -> impl Future<Output = ()> + Send

Returns the set of information that was given to the component framework by this component’s resolver.

fn get_child_output_dictionary( &mut self, sender: &ServerSender<Realm, ___T>, request: Request<GetChildOutputDictionary, ___T>, responder: Responder<GetChildOutputDictionary>, ) -> impl Future<Output = ()> + Send

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors