Struct CompositionGraph

pub struct CompositionGraph<'a> { /* private fields */ }

Represents a composition graph used to compose a new component from other components.

Implementations

impl<'a> CompositionGraph<'a>

pub fn new() -> Self

Constructs a new composition graph.

pub fn add_component(&mut self, component: Component<'a>) -> Result<ComponentId>

Adds a new component to the graph.

The component name must be unique.

pub fn get_component( &self, id: impl Into<ComponentId>, ) -> Option<&Component<'a>>

Gets a component from the graph.

pub fn get_component_by_name( &self, name: &str, ) -> Option<(ComponentId, &Component<'a>)>

Gets a component from the graph by name.

pub fn remove_component(&mut self, id: impl Into<ComponentId>)

Removes a component from the graph.

All instances and connections relating to the component will also be removed.

pub fn instantiate(&mut self, id: impl Into<ComponentId>) -> Result<InstanceId>

Creates a new instance of a component in the composition graph.

pub fn get_component_of_instance( &self, id: impl Into<InstanceId>, ) -> Option<(ComponentId, &Component<'_>)>

Gets the component of the given instance.

pub fn remove_instance(&mut self, id: impl Into<InstanceId>)

Removes an instance from the graph.

All connections relating to the instance will also be removed.

pub fn connect( &mut self, source: impl Into<InstanceId> + Copy, source_export: Option<impl Into<ExportIndex> + Copy>, target: impl Into<InstanceId> + Copy, target_import: impl Into<ImportIndex> + Copy, ) -> Result<()>

Creates a connection (edge) between instances in the composition graph.

A connection represents an instantiation argument.

If source_export is None, the source instance itself is used as the instantiation argument.

pub fn disconnect( &mut self, source: impl Into<InstanceId>, target: impl Into<InstanceId>, target_import: impl Into<ImportIndex>, ) -> Result<()>

Disconnects a previous connection between instances.

Requires that the source and target instances are valid.

If the source and target are not connected via the target’s import, then this is a no-op.

pub fn validate_connection( &self, source: impl Into<InstanceId>, source_export: Option<impl Into<ExportIndex>>, target: impl Into<InstanceId>, target_import: impl Into<ImportIndex>, ) -> Result<()>

Validates a connection between two instances in the graph.

Use None for source_export to signify that the instance itself should be the source for the connection.

Returns Err(_) if the connection would not be valid.

pub fn encode(&self, options: EncodeOptions) -> Result<Vec<u8>>

Encodes the current composition graph as a WebAssembly component.

Trait Implementations

impl<'a> Debug for CompositionGraph<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CompositionGraph<'a>

fn default() -> CompositionGraph<'a>

Returns the “default value” for a type.