Expand description
A typed layer over the untyped syntax tree.
The AST is rooted in the Markup node.
Structs§
- Args
- A function call’s argument list:
(12pt, y). - Array
- An array:
(1, "hi", 12cm). - Auto
- The
autoliteral. - Binary
- A binary operation:
a + b. - Bool
- A boolean:
true,false. - Closure
- A closure:
(x, y) => z. - Code
- The body of a code block.
- Code
Block - A code block:
{ let x = 1; x + 2 }. - Conditional
- An if-else conditional:
if x { y } else { z }. - Content
Block - A content block:
[*Hi* there!]. - Contextual
- A contextual expression:
context text.lang. - Destruct
Assignment - An assignment expression
(x, y) = (1, 2). - Destructuring
- A destructuring pattern:
xor(x, _, ..y). - Dict
- A dictionary:
(thickness: 3pt, pattern: dashed). - Emph
- Emphasized content:
_Emphasized_. - Enum
Item - An item in an enumeration (numbered list):
+ ...or1. .... - Equation
- A mathematical equation:
$x$,$ x^2 $. - Escape
- An escape sequence:
\#,\u{1F5FA}. - Field
Access - A field access:
properties.age. - Float
- A floating-point number:
1.2,10e-4. - ForLoop
- A for loop:
for x in y { z }. - Func
Call - An invocation of a function or method:
f(x, y). - Func
Return - A return from a function:
return,return x + 1. - Heading
- A section heading:
= Introduction. - Ident
- An identifier:
it. - Import
Item Path - A path to a submodule’s imported name:
a.b.c. - Import
Items - Items to import from a module:
a, b, c. - Int
- An integer:
120. - Keyed
- A keyed pair:
"spacy key": true. - Label
- A label:
<intro>. - LetBinding
- A let binding:
let x = 1. - Linebreak
- A forced line break:
\. - Link
- A hyperlink:
https://typst.org. - List
Item - An item in a bullet list:
- .... - Loop
Break - A break from a loop:
break. - Loop
Continue - A continue in a loop:
continue. - Markup
- The syntactical root capable of representing a full parsed document.
- Math
- The contents of a mathematical equation:
x^2 + 1. - Math
Align Point - An alignment point in math:
&. - Math
Attach - A base with optional attachments in math:
a_1^2. - Math
Delimited - Matched delimiters in math:
[x + y]. - Math
Frac - A fraction in math:
x/2 - Math
Ident - An identifier in math:
pi. - Math
Primes - Grouped primes in math:
a'''. - Math
Root - A root in math:
√x,∛xor∜x. - Math
Shorthand - A shorthand for a unicode codepoint in math:
a <= b. - Module
Import - A module import:
import "utils.typ": a, b, c. - Module
Include - A module include:
include "chapter1.typ". - Named
- A named pair:
thickness: 3pt. - None
- The
noneliteral. - Numeric
- A numeric value with a unit:
12pt,3cm,2em,90deg,50%. - Params
- A closure’s parameters:
(x, y). - Parbreak
- A paragraph break, indicated by one or multiple blank lines.
- Parenthesized
- A grouped expression:
(1 + 2). - Raw
- Raw text with optional syntax highlighting:
`...`. - RawDelim
- A raw delimiter in single or 3+ backticks:
`. - RawLang
- A language tag at the start of raw element:
typ. - Ref
- A reference:
@target,@target[..]. - Renamed
Import Item - A renamed import item:
a as d - SetRule
- A set rule:
set text(...). - Shorthand
- A shorthand for a unicode codepoint. For example,
~for a non-breaking space or-?for a soft hyphen. - Show
Rule - A show rule:
show heading: it => emph(it.body). - Smart
Quote - A smart quote:
'or". - Space
- Whitespace in markup or math. Has at most one newline in markup, as more indicate a paragraph break.
- Spread
- A spread:
..xor..x.at(0). - Str
- A quoted string:
"...". - Strong
- Strong content:
*Strong*. - Term
Item - An item in a term list:
/ Term: Details. - Text
- Plain text without markup.
- Unary
- A unary operation:
-x. - Underscore
- An underscore:
_ - While
Loop - A while loop:
while x { y }.
Enums§
- Arg
- An argument to a function call.
- Array
Item - An item in an array.
- Assoc
- The associativity of a binary operator.
- BinOp
- A binary operator.
- Destructuring
Item - The kind of an element in a destructuring pattern.
- Dict
Item - An item in an dictionary expression.
- Expr
- An expression in markup, math or code.
- Import
Item - An imported item, potentially renamed to another identifier.
- Imports
- The items that ought to be imported from a file.
- LetBinding
Kind - The kind of a let binding, either a normal one or a closure.
- Param
- A parameter to a closure.
- Pattern
- The kind of a pattern.
- UnOp
- A unary operator.
- Unit
- Unit of a numeric value.
Traits§
- AstNode
- A typed AST node.