Module cl_ast::ast

The Abstract Syntax Tree

Contains definitions of Conlang AST Nodes.

Notable nodes

• Item and ItemKind: Top-level constructs
• Stmt and StmtKind: Statements
• Expr and ExprKind: Expressions
  • Assign, Modify, Binary, and Unary expressions
  • ModifyKind, BinaryKind, and UnaryKind operators
• Ty and TyKind: Type qualifiers
• Path: Path expressions

Structs

• AddrOf
  An address-of expression: & mut? Expr
• Alias
  An alias to another Ty
• Array
  An Array literal: [ Expr (, Expr)* ]
• ArrayRep
  An Array literal constructed with repeat syntax [ Expr ; Literal ]
• Assign
  An Assignment expression: Expr (ModifyKind Expr)+
• Attrs
  A list of Meta decorators
• Binary
  A Binary expression: Expr (BinaryKind Expr)+
• Block
  A Block expression: { Stmt* Expr? }
• Break
  A Break expression: break Expr?
• Const
  A compile-time constant
• Continue
  A continue expression: continue
• Else
  The (optional) else clause of a While, If, or For expression
• Enum
  A user-defined sum type
• Expr
  An expression, the beating heart of the language
• Fielder
  A [Struct field initializer] expression: Sym (= Expr)?
• File
  A list of Items
• For
  A For expression: for Pattern in Expr Block Else?
• Function
  Code, and the interface to that code
• Group
  A Grouping expression ( Expr )
• If
  An If expression: if Expr Block Else?
• Impl
  Sub-items (associated functions, etc.) for a Ty
• Index
  A repeated Index expression: a[10, 20, 30][40, 50, 60]
• Item
  Anything that can appear at the top level of a File
• Let
  A local variable declaration Stmt
• Loop
  A Loop expression: loop Block
• Member
  A Member access expression: Expr MemberKind*
• Meta
  A metadata decorator
• Modify
  A Modify-assignment expression: Expr (ModifyKind Expr)+
• Module
  An ordered collection of Items
• Param
  A single parameter for a Function
• Path
  A path to an Item in the Module tree
• Return
  A Return expression return Expr?
• Static
  A static variable
• Stmt
  An abstract statement, and associated metadata
• Struct
  A user-defined product type
• StructMember
  The Visibility, Sym, and Type of a single Struct member
• Structor
  A Struct creation expression: Path { (Fielder ,)* Fielder? }
• Tuple
  A Tuple expression: ( Expr (, Expr)+ )
• Ty
  A type expression
• TyFn
  The args and return value for a function pointer Type
• TyRef
  A Type-reference expression as (number of &, Path)
• TyTuple
  A tuple of Types
• Unary
  A Unary expression: UnaryKind* Expr
• Use
  An import of nonlocal Items
• Variant
  A single Enum variant
• While
  A While expression: while Expr Block Else?

Enums

• BinaryKind
  A Binary operator
• EnumKind
  An Enum’s Variants, if it has a variant block
• ExprKind
  Any of the different Expressions
• ImplKind
• ItemKind
  What kind of Item is this?
• Literal
  A Literal: 0x42, 1e123, 2.4, “Hello”
• MemberKind
  The kind of Member access
• MetaKind
  Information attached to Metadata
• ModifyKind
• ModuleKind
  The contents of a Module, if they’re in the same file
• Mutability
  Whether a binding (Static or Let) or reference is mutable or not
• PathPart
  A single component of a Path
• Semi
  Whether or not a Stmt is followed by a semicolon
• StmtKind
  Whether the Stmt is a Let, Item, or Expr statement
• StructKind
  Either a Struct’s StructMembers or tuple Types, if present.
• TyKind
  Information about a Type expression
• UnaryKind
  A Unary operator
• UseTree
  A tree of Item imports
• VariantKind
  Whether the Variant has a C-like constant value, a tuple, or StructMembers
• Visibility
  Whether an Item is visible outside of the current Module

Type Aliases

• Sym
  An Interned static str, used in place of an identifier