a11::flow::syntax::Stage Struct Reference

One | name arg stage of a pipeline. More...

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

Inheritance diagram for a11::flow::syntax::Stage:

Public Attributes
std::string	name
vocabulary::StageArgument	takes = vocabulary::StageArgument::kNone
double	number = 0.0
	kNumber: the count, and whether it was written as a whole number.
bool	is_integer = false
std::string	text
	kString/kOptionalString: the text, with escapes resolved.
NodePtr	argument
	kExpression/kOptionalExpression: the expression, with it bound.
absl::Duration	duration
	kDuration: how long timeout waits, or pace spaces values out by.
bool	descending = false
	kSortKey: whether desc was written.
Constant	start
	kFold: the literal to start from and the name bound to what the last value produced.
Word	carried
bool	tolerant = false
	try map ...: a value this stage cannot do is dropped rather than ending the pipeline.
NodePtr	failures
	into ref: where a tolerated failure goes, as a status record.
int	parallel = 1
	parallel n: how many values this stage may be working on at once.
bool	ordered = true
	Whether the values leave in the order they arrived.
LogTail	log
	kLog/kLogFormat: what was written after the stage name.
Public Attributes inherited from a11::flow::syntax::Node
NodeKind	kind = NodeKind::kError
Location	location

Additional Inherited Members
Public Member Functions inherited from a11::flow::syntax::NodeOf< NodeKind::kStage >
	NodeOf ()
Public Member Functions inherited from a11::flow::syntax::Node
virtual	~Node ()=default
Static Public Attributes inherited from a11::flow::syntax::NodeOf< NodeKind::kStage >
static constexpr NodeKind	kNodeKind

Detailed Description

One | name arg stage of a pipeline.

takes says which of the argument fields is the one that was filled, and is read from the vocabulary rather than decided here: the stage table is the one table, and a stage the language does not have is a diagnostic, not a shape.

Member Data Documentation

argument

NodePtr a11::flow::syntax::Stage::argument

kExpression/kOptionalExpression: the expression, with it bound.

kSortKey: the by key, or null for the values themselves. kFold: the fold expression, with the carried name and it bound. kStream: the stream to read next.

carried

Word a11::flow::syntax::Stage::carried

descending

bool a11::flow::syntax::Stage::descending = false

kSortKey: whether desc was written.

duration

absl::Duration a11::flow::syntax::Stage::duration

kDuration: how long timeout waits, or pace spaces values out by.

failures

NodePtr a11::flow::syntax::Stage::failures

into ref: where a tolerated failure goes, as a status record.

Null when the failures are only logged.

is_integer

bool a11::flow::syntax::Stage::is_integer = false

log

LogTail a11::flow::syntax::Stage::log

kLog/kLogFormat: what was written after the stage name.

The same shape the statement of the same name carries.

name

std::string a11::flow::syntax::Stage::name

number

double a11::flow::syntax::Stage::number = 0.0

kNumber: the count, and whether it was written as a whole number.

ordered

bool a11::flow::syntax::Stage::ordered = true

Whether the values leave in the order they arrived.

True unless unordered was written: a parallel stage finishes its values out of order and puts them back in order on the way out, so everything after it reads the stream the author wrote.

parallel

int a11::flow::syntax::Stage::parallel = 1

parallel n: how many values this stage may be working on at once.

One means the stage sees them one at a time, which is the default.

start

Constant a11::flow::syntax::Stage::start

kFold: the literal to start from and the name bound to what the last value produced.

A literal rather than an expression, because fold 0 as total would otherwise read as a cast of 0 to a type.

takes

vocabulary::StageArgument a11::flow::syntax::Stage::takes = vocabulary::StageArgument::kNone

text

std::string a11::flow::syntax::Stage::text

kString/kOptionalString: the text, with escapes resolved.

tolerant

bool a11::flow::syntax::Stage::tolerant = false

try map ...: a value this stage cannot do is dropped rather than ending the pipeline.

Written before the stage name, as try run is before a call.

---

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

• cpp/a11/flow/syntax.h