Struct Graph 

pub struct Graph { /* private fields */ }

A decode graph under construction.

Implementations

impl Graph

pub fn new() -> Self

An empty graph with the default limits.

pub fn with_config(config: GraphConfig) -> Self

An empty graph with config’s limits.

pub fn config(&self) -> GraphConfig

The graph’s limits.

pub fn source(&mut self, spec: SourceSpec) -> Result<SourceHandle, GraphError>

Adds a source of logic samples.

pub fn add(&mut self, node: impl Node) -> NodeId

Adds a node.

pub fn connect<T>( &mut self, from: OutputRef<T>, to: InputRef<T>, ) -> Result<(), GraphError>

Connects an output to an input, checking that they carry the same schema and that the output satisfies what the input requires.

pub fn expose<T>( &mut self, name: impl Into<String>, from: OutputRef<T>, ) -> Result<ExposedRef<T>, GraphError>

Exposes an output under name, to be read from the pipeline.

pub fn source_output(&self, source: SourceId) -> Result<DynOutput, GraphError>

The samples output of source, for a graph built from a description.

pub fn output(&self, node: NodeId, name: &str) -> Result<DynOutput, GraphError>

Output port name of node, for a graph built from a description.

pub fn input(&self, node: NodeId, name: &str) -> Result<DynInput, GraphError>

Input port name of node, for a graph built from a description.

pub fn connect_dyn( &mut self, from: DynOutput, to: DynInput, ) -> Result<(), GraphError>

Connects ports named at run time, with the checks of Graph::connect; the schema check is what keeps the event types straight here.

pub fn expose_dyn( &mut self, name: impl Into<String>, from: DynOutput, ) -> Result<DynExposedRef, GraphError>

Exposes an output named at run time under name.

pub fn schema_of(&self, output: DynOutput) -> Result<SchemaId, GraphError>

The schema of the output behind a port named at run time.

pub fn props_of(&self, output: DynOutput) -> Result<Props, GraphError>

The properties the output behind a port named at run time declares.

pub fn build(self) -> Result<Pipeline, GraphError>

Checks the graph and starts its nodes.

Trait Implementations

impl Debug for Graph

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

Formats the value using the given formatter.

impl Default for Graph

fn default() -> Self

Returns the “default value” for a type.