A11 (C++ runtime)
Native C++ implementation of the A11 streaming action runtime
Loading...
Searching...
No Matches
a11::flow::PortPlan Struct Reference

One declared port of a flow, resolved. More...

#include <cpp/a11/flow/plan.h>

Public Attributes

std::string name
 
syntax::PortDirection direction = syntax::PortDirection::kInput
 
std::string declared
 The type as the flow wrote it, parameters and all: list[string].
 
std::optional< syntax::TypeExpression > syntax_type
 
std::string type
 What the type is, for the schema a caller sees: a built-in's mimetype or Python type name, a registry tag, or a quoted mimetype, exactly as a11.flow.plan.TYPE_NAMES resolves it.
 
bool unary = true
 
bool required = false
 
std::string description
 
std::vector< std::string > constraints
 
std::shared_ptr< const DtoPlan > analysis_shape
 
syntax::Location location
 

Detailed Description

One declared port of a flow, resolved.

Member Data Documentation

◆ analysis_shape

std::shared_ptr<const DtoPlan> a11::flow::PortPlan::analysis_shape

◆ constraints

std::vector<std::string> a11::flow::PortPlan::constraints

◆ declared

std::string a11::flow::PortPlan::declared

The type as the flow wrote it, parameters and all: list[string].

◆ description

std::string a11::flow::PortPlan::description

◆ direction

syntax::PortDirection a11::flow::PortPlan::direction = syntax::PortDirection::kInput

◆ location

syntax::Location a11::flow::PortPlan::location

◆ name

std::string a11::flow::PortPlan::name

◆ required

bool a11::flow::PortPlan::required = false

◆ syntax_type

std::optional<syntax::TypeExpression> a11::flow::PortPlan::syntax_type

◆ type

std::string a11::flow::PortPlan::type

What the type is, for the schema a caller sees: a built-in's mimetype or Python type name, a registry tag, or a quoted mimetype, exactly as a11.flow.plan.TYPE_NAMES resolves it.

◆ unary

bool a11::flow::PortPlan::unary = true

The documentation for this struct was generated from the following file: