Struct TopologyBlueprint 

pub struct TopologyBlueprint { /* private fields */ }

A topology blueprint represents a directed graph of components.

Implementations

impl TopologyBlueprint

pub fn new(name: &str, component_registry: &ComponentRegistry) -> Self

Creates an empty TopologyBlueprint with the given name.

pub fn with_interconnect_capacity( &mut self, capacity: NonZeroUsize, ) -> &mut Self

Sets the capacity of interconnects in the topology.

Interconnects are used to connect components to one another. Once their capacity is reached, no more items can be sent through until in-flight items are processed. This will apply backpressure to the upstream components. Raising or lowering the capacity allows trading off throughput at the expense of memory usage.

Defaults to 128.

pub fn add_source<I, B>( &mut self, component_id: I, builder: B, ) -> Result<&mut Self, GenericError>

where I: AsRef<str>, B: SourceBuilder + Send + 'static,

Adds a source component to the blueprint.

Errors

If the component ID is invalid or the component cannot be added to the graph, an error is returned.

pub fn add_transform<I, B>( &mut self, component_id: I, builder: B, ) -> Result<&mut Self, GenericError>

where I: AsRef<str>, B: TransformBuilder + Send + 'static,

Adds a transform component to the blueprint.

Errors

If the component ID is invalid or the component cannot be added to the graph, an error is returned.

pub fn add_destination<I, B>( &mut self, component_id: I, builder: B, ) -> Result<&mut Self, GenericError>

where I: AsRef<str>, B: DestinationBuilder + Send + 'static,

Adds a destination component to the blueprint.

Errors

If the component ID is invalid or the component cannot be added to the graph, an error is returned.

pub fn add_encoder<I, B>( &mut self, component_id: I, builder: B, ) -> Result<&mut Self, GenericError>

where I: AsRef<str>, B: EncoderBuilder + Send + 'static,

Adds an encoder component to the blueprint.

Errors

If the component ID is invalid or the component cannot be added to the graph, an error is returned.

pub fn add_forwarder<I, B>( &mut self, component_id: I, builder: B, ) -> Result<&mut Self, GenericError>

where I: AsRef<str>, B: ForwarderBuilder + Send + 'static,

Adds a forwarder component to the blueprint.

Errors

If the component ID is invalid or the component cannot be added to the graph, an error is returned.

pub fn connect_component<DI, SI, I>( &mut self, destination_component_id: DI, source_output_component_ids: SI, ) -> Result<&mut Self, GenericError>

where DI: AsRef<str>, SI: IntoIterator<Item = I>, I: AsRef<str>,

Connects one or more source component outputs to a destination component.

Errors

If the destination component ID, or any of the source component IDs, are invalid or do not exist, or if the data types between one of the source/destination component pairs is incompatible, an error is returned.

pub async fn build(self) -> Result<BuiltTopology, GenericError>

Builds the topology.

Errors

If any of the components could not be built, an error is returned.