Table of Contents

Namespace Invex.StructuredText.Expressions

Classes

BoolCast

Treats Operand as a boolean. Rendered transparently.

BoolContext

A boolean-valued context path.

BoolExpr

An expression that evaluates to a boolean.

BoolFunction

A function call that returns a boolean.

BoolLiteral

A boolean literal.

ComparisonExpr

A comparison between two values.

Expr

The base type of the typed expression tree. Every node derives from one of the four result-typed roots: BoolExpr, StringExpr, NumberExpr or JsonExpr.

ExpressionPrinter

Renders typed expression trees (Expr) and Templates to platform syntax.

FunctionNames

Canonical names of the functions the core knows about. Printers map them to the platform's own names.

IndexAccessExpr

Accesses element Index of Target.

InputRef

An input (parameter) supplied when the run was started.

JobOutputRef

An output of another job that the current job depends on.

JobResultRef

The result of another job that the current job depends on. Compare with ResultLiteral.

JsonContext

A context path whose value is an object, an array or of unknown type.

JsonExpr

An expression whose value is an object, an array, or of a type not known statically.

JsonFunction

A function call that returns an object, an array or a value of unknown type.

LogicalExpr

An AND or OR over two or more conditions. Nested nodes with the same operator are flattened.

MatrixRef

The current value of a matrix dimension.

MemberAccessExpr

Accesses Property of Target.

NotExpr

The logical negation of Operand.

NullLiteral

The null literal.

NumberCast

Treats Operand as a number. Rendered transparently.

NumberContext

A number-valued context path.

NumberExpr

An expression that evaluates to a number.

NumberLiteral

A numeric literal, rendered with the invariant culture.

RawExpr

Verbatim expression text, created by Raw(string). It is a condition, and converts implicitly to string, number and JSON expressions.

RawJson

Verbatim expression text of an object, array or unknown type.

RawNumber

Verbatim number-valued expression text.

RawString

Verbatim string-valued expression text.

ReferenceExpr

A reference to a value every supported platform provides (a secret, variable, input, matrix value or output). Each platform's printer decides the syntax.

ResultLiteral

A result value, rendered with the platform's own spelling.

SecretRef

A secret.

StepOutputRef

An output of an earlier step in the current job.

StringCast

Treats Operand as a string. Rendered transparently.

StringContext

A string-valued context path.

StringExpr

An expression that evaluates to a string.

StringFunction

A function call that returns a string.

StringLiteral

A string literal, rendered quoted and escaped.

Template

A text value made of literal text and embedded expressions, such as a YAML scalar.

Tex

The starting point for writing expressions. Everything that creates an expression from scratch lives here: references (Secret(string), JobOutput(string, string, string?), …), status checks (Success(), …), functions (All(params IEnumerable<BoolExpr>), Format(StringExpr, params IEnumerable<Expr>), …) and the escape hatch Raw(string). Platform packages add their own members, such as Tex.GitHub for the GitHub Actions contexts.

VariableRef

A configuration variable defined outside the workflow.

Structs

TemplatePart

One part of a Template: either literal text or an embedded expression.

Interfaces

IContextPath

Implemented by nodes that reference a dotted context path such as a.b.c.

IRawExpr

Implemented by nodes that hold verbatim expression text.

Enums

ComparisonOperator

The comparison operators.

LogicalOperator

The logical operators.

RunResult

The possible results of a job or step.