Struct SubRealmBuilder

pub struct SubRealmBuilder { /* private fields */ }

Implementations

impl SubRealmBuilder

pub async fn add_child_realm( &self, name: impl Into<String>, options: ChildOptions, ) -> Result<Self, Error>

pub async fn add_child_realm_from_relative_url( &self, name: impl Into<String>, relative_url: impl Into<String>, options: ChildOptions, ) -> Result<SubRealmBuilder, Error>

pub async fn add_child_realm_from_decl( &self, name: impl Into<String>, decl: ComponentDecl, options: ChildOptions, ) -> Result<SubRealmBuilder, Error>

pub async fn add_local_child<M>( &self, name: impl Into<String>, local_component_implementation: M, options: ChildOptions, ) -> Result<ChildRef, Error>

where M: Fn(LocalComponentHandles) -> BoxFuture<'static, Result<(), Error>> + Sync + Send + 'static,

Adds a new local component to the realm

pub async fn add_child( &self, name: impl Into<String>, url: impl Into<String>, options: ChildOptions, ) -> Result<ChildRef, Error>

Adds a new component to the realm by URL

pub async fn add_child_from_decl( &self, name: impl Into<String>, decl: ComponentDecl, options: ChildOptions, ) -> Result<ChildRef, Error>

Adds a new component to the realm with the given component declaration

pub async fn get_component_decl( &self, child_ref: impl Into<ChildRef>, ) -> Result<ComponentDecl, Error>

Returns a copy the decl for a child in this realm

pub async fn replace_component_decl( &self, child_ref: impl Into<ChildRef>, decl: ComponentDecl, ) -> Result<(), Error>

Replaces the decl for a child of this realm

pub async fn get_realm_decl(&self) -> Result<ComponentDecl, Error>

Returns a copy the decl for this realm

pub async fn replace_realm_decl(&self, decl: ComponentDecl) -> Result<(), Error>

Replaces the decl for this realm

pub async fn init_mutable_config_from_package( &self, child_ref: impl Into<ChildRef>, ) -> Result<(), Error>

Load the packaged structured config values for the component.

pub async fn init_mutable_config_to_empty( &self, child_ref: impl Into<ChildRef>, ) -> Result<(), Error>

Load the packaged structured config values for the component.

pub async fn set_config_value( &self, child_ref: impl Into<ChildRef>, key: &str, value: ConfigValue, ) -> Result<(), Error>

Replaces a value of a given configuration field

pub async fn add_route(&self, route: Route) -> Result<(), Error>

Adds a route between components within the realm

pub async fn read_only_directory( &self, directory_name: impl Into<String>, to: Vec<impl Into<Ref>>, directory_contents: DirectoryContents, ) -> Result<(), Error>

Creates and routes a read-only directory capability to the given targets. The directory capability will have the given name, and anyone accessing the directory will see the given contents.

pub async fn add_capability( &self, capability: CapabilityDecl, ) -> Result<(), Error>

Adds a Configuration Capability to the root realm and routes it to the given targets.

pub async fn add_collection( &self, collection: CollectionDecl, ) -> Result<CollectionRef, Error>

Adds a Collection to the root realm.

pub async fn add_environment( &self, environment: EnvironmentDecl, ) -> Result<(), Error>

Adds a Environment to the root realm.

pub async fn with_nested_component_manager( &self, component_manager_fragment_only_url: &str, ) -> Result<(), Error>

Initializes the created realm under an instance of component manager, specified by the given fragment-only URL.

This function should be used to modify the component manager realm. Otherwise, to directly build the created realm under an instance of component manager, use build_in_nested_component_manager().

NOTE: Any routes passed through from the parent need to be routed to “#realm_builder” in the test component’s CML file.

Trait Implementations

impl Clone for SubRealmBuilder

fn clone(&self) -> SubRealmBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubRealmBuilder

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

Formats the value using the given formatter.

impl From<&SubRealmBuilder> for ChildRef

fn from(input: &SubRealmBuilder) -> ChildRef

Converts to this type from the input type.

impl From<&SubRealmBuilder> for CollectionRef

fn from(input: &SubRealmBuilder) -> CollectionRef

Converts to this type from the input type.

impl From<&SubRealmBuilder> for Ref

A SubRealmBuilder may be referenced as a child in a route, in order to route a capability to or from the sub realm.

fn from(input: &SubRealmBuilder) -> Ref

Converts to this type from the input type.