Structures Reference

AST

An abstract syntax tree.

Declaration

Swift

public struct AST : Sendable

extension AST: Codable

Show on GitHub


                    
                    
                    CoreEntities

A helper to project core entities from an AST.

Declaration

Swift

@dynamicMemberLookup
public struct CoreEntities : Sendable

Show on GitHub


                    
                    
                    CoreTrait

An entity declared in Hylo’s standard library.

Declaration

Swift

@dynamicMemberLookup
public struct CoreTrait<T> where T : CoreTraitDescription

Show on GitHub


                    
                    
                    CoreTraits

A view of the traits in Hylo’s standard library that are known by the compiler.

Declaration

Swift

public struct CoreTraits : Codable, Sendable

Show on GitHub


                    
                    
                    CollectionDescription

A view of Hylo.Collection‘s declaration from the standard library.

Declaration

Swift

public struct CollectionDescription : CoreTraitDescription

Show on GitHub


                    
                    
                    CopyableDescription

A view of Hylo.Copyable‘s declaration from the standard library.

Declaration

Swift

public struct CopyableDescription : CoreTraitDescription

Show on GitHub


                    
                    
                    DeinitializableDescription

A view of Hylo.Deinitializable‘s declaration from the standard library.

Declaration

Swift

public struct DeinitializableDescription : CoreTraitDescription

Show on GitHub


                    
                    
                    EquatableDescription

A view of Hylo.Equatable‘s declaration from the standard library.

Declaration

Swift

public struct EquatableDescription : CoreTraitDescription

Show on GitHub


                    
                    
                    ExpressibleByFloatLiteralDescription

A view of Hylo.ExpressibleByFloatLiteral‘s declaration from the standard library.

Declaration

Swift

public struct ExpressibleByFloatLiteralDescription : CoreTraitDescription

Show on GitHub


                    
                    
                    ExpressibleByIntegerLiteralDescription

A view of Hylo.ExpressibleByIntegerLiteral‘s declaration from the standard library.

Declaration

Swift

public struct ExpressibleByIntegerLiteralDescription : CoreTraitDescription

Show on GitHub


                    
                    
                    ForeignConvertibleDescription

A view of Hylo.ForeignConvertible‘s declaration from the standard library.

Declaration

Swift

public struct ForeignConvertibleDescription : CoreTraitDescription

Show on GitHub


                    
                    
                    IteratorDescription

A view of Hylo.Iterator‘s declaration from the standard library.

Declaration

Swift

public struct IteratorDescription : CoreTraitDescription

Show on GitHub


                    
                    
                    MovableDescription

A view of Hylo.Movable‘s declaration from the standard library.

Declaration

Swift

public struct MovableDescription : CoreTraitDescription

Show on GitHub


                    
                    
                    Diagnostic

A diagnostic related to a region of Hylo source code.

Declaration

Swift

public struct Diagnostic : Hashable, Sendable

extension Diagnostic: CustomStringConvertible

Show on GitHub


                    
                    
                    UseVisitor

The state of the visitor gathering uses.

Declaration

Swift

private struct UseVisitor : ASTWalkObserver

Show on GitHub


                    
                    
                    AnyNode

A type-erasing container for AST nodes.

Declaration

Swift

struct AnyNode : Codable, Sendable

Show on GitHub


                    
                    
                    Attribute

An attribute.

Declaration

Swift

public struct Attribute : Codable, Sendable

Show on GitHub


                    
                    
                    BundledNode

A projection from a Program of a node along with its extrinsic relationships.

Declaration

Swift

@dynamicMemberLookup
public struct BundledNode<T, P> : Sendable where T : NodeIDProtocol, P : Program

extension BundledNode: Hashable

extension BundledNode: CustomStringConvertible

Show on GitHub


                    
                    
                    AssociatedTypeDecl

An associated type declaration.

Declaration

Swift

public struct AssociatedTypeDecl : SingleEntityDecl, ConstrainedGenericTypeDecl

Show on GitHub


                    
                    
                    AssociatedValueDecl

An associated value declaration.

Declaration

Swift

public struct AssociatedValueDecl : SingleEntityDecl

Show on GitHub


                    
                    
                    BindingDecl

A binding declaration.

Declaration

Swift

public struct BindingDecl : ExposableDecl

Show on GitHub


                    
                    
                    ConformanceDecl

A declaration that extends a type with new conformances.

Declaration

Swift

public struct ConformanceDecl : ConformanceSource, TypeExtendingDecl

Show on GitHub


                    
                    
                    ExtensionDecl

A declaration that extends a type with new members.

Declaration

Swift

public struct ExtensionDecl : TypeExtendingDecl

Show on GitHub


                    
                    
                    FunctionDecl

A function declaration.

Declaration

Swift

public struct FunctionDecl : CapturingDecl, ExposableDecl, GenericDecl

Show on GitHub


                    
                    
                    GenericClause

A generic clause.

Declaration

Swift

public struct GenericClause : Codable, Sendable

Show on GitHub


                    
                    
                    GenericParameterDecl

A generic parameter declaration.

Declaration

Swift

public struct GenericParameterDecl : SingleEntityDecl, ConstrainedGenericTypeDecl

Show on GitHub


                    
                    
                    ImplicitCapture

An implicit capture in a function or subscript declaration.

Declaration

Swift

public struct ImplicitCapture : Hashable, Sendable

extension ImplicitCapture: Monotonic

Show on GitHub


                    
                    
                    ImportDecl

An import declaration.

Declaration

Swift

public struct ImportDecl : SingleEntityDecl

Show on GitHub


                    
                    
                    InitializerDecl

An initializer declaration.

Declaration

Swift

public struct InitializerDecl : ExposableDecl, GenericDecl

Show on GitHub


                    
                    
                    MethodDecl

A method declaration.

Declaration

Swift

public struct MethodDecl : BundleDecl, GenericDecl

Show on GitHub


                    
                    
                    MethodImpl

The declaration of a method implementation.

Instances of this type represent individual variant inside a method declaration.

Declaration

Swift

public struct MethodImpl : BundleImpl, LexicalScope

Show on GitHub


                    
                    
                    ModuleDecl

A module declaration.

Declaration

Swift

public struct ModuleDecl : SingleEntityDecl, LexicalScope

Show on GitHub


                    
                    
                    NamespaceDecl

A namespace declaration.

Declaration

Swift

public struct NamespaceDecl : ExposableDecl, SingleEntityDecl, LexicalScope

Show on GitHub


                    
                    
                    OperatorDecl

An operator declaration.

Declaration

Swift

public struct OperatorDecl : ExposableDecl

Show on GitHub


                    
                    
                    ParameterDecl

A parameter declaration in a function or subscript declaration.

Declaration

Swift

public struct ParameterDecl : SingleEntityDecl

Show on GitHub


                    
                    
                    ProductTypeDecl

A (nominal) product type declaration.

Declaration

Swift

public struct ProductTypeDecl : ConformanceSource, GenericDecl, SingleEntityDecl

Show on GitHub


                    
                    
                    SubscriptDecl

A subscript declaration.

Declaration

Swift

public struct SubscriptDecl : BundleDecl, CapturingDecl, GenericDecl

Show on GitHub


                    
                    
                    SubscriptImpl

The declaration of a subscript implementation.

Instances of this type represent individual variant inside a subscript declaration.

Declaration

Swift

public struct SubscriptImpl : BundleImpl, LexicalScope

Show on GitHub


                    
                    
                    SynthesizedFunctionDecl

A function declaration synthesized during compilation.

Declaration

Swift

public struct SynthesizedFunctionDecl : Hashable, Sendable

extension SynthesizedFunctionDecl: CustomStringConvertible

Show on GitHub


                    
                    
                    TraitDecl

A trait declaration.

Note

TraitDecl does not conform to GenericDecl.

Declaration

Swift

public struct TraitDecl : ExposableDecl, SingleEntityDecl, LexicalScope

extension TraitDecl: GenericScope

Show on GitHub


                    
                    
                    TranslationUnit

A collection of declarations at the top-level of a source file.

Declaration

Swift

public struct TranslationUnit : Node, LexicalScope

Show on GitHub


                    
                    
                    TypeAliasDecl

A type alias declaration.

Declaration

Swift

public struct TypeAliasDecl : ExposableDecl, GenericDecl, SingleEntityDecl

Show on GitHub


                    
                    
                    VarDecl

A variable declaration associated with a name in a binding declaration.

Declaration

Swift

public struct VarDecl : SingleEntityDecl

Show on GitHub


                    
                    
                    WhereClause

A where clause.

Declaration

Swift

public struct WhereClause : Codable, Sendable

Show on GitHub


                    
                    
                    ArrowTypeExpr

An arrow type expression.

Declaration

Swift

public struct ArrowTypeExpr : Expr

Show on GitHub


                    
                    
                    BooleanLiteralExpr

A boolean literal expression.

Declaration

Swift

public struct BooleanLiteralExpr : Expr

Show on GitHub


                    
                    
                    BufferLiteralExpr

A buffer literal expression.

Declaration

Swift

public struct BufferLiteralExpr : Expr

Show on GitHub


                    
                    
                    CaptureExpr

The capture of an access on a value.

Declaration

Swift

public struct CaptureExpr : Expr

Show on GitHub


                    
                    
                    CastExpr

An explicit cast expression.

Declaration

Swift

public struct CastExpr : Expr

Show on GitHub


                    
                    
                    ConditionalExpr

A conditional expression.

Declaration

Swift

public struct ConditionalExpr : Expr, LexicalScope

Show on GitHub


                    
                    
                    ConformanceLensExpr

A conformance lens.

Declaration

Swift

public struct ConformanceLensExpr : Expr

Show on GitHub


                    
                    
                    ExistentialTypeExpr

The expression of an existential type (e.g., any P & Q or any Array).

Declaration

Swift

public struct ExistentialTypeExpr : Expr

Show on GitHub


                    
                    
                    FloatLiteralExpr

A floating-point number literal expression.

Declaration

Swift

public struct FloatLiteralExpr : NumericLiteralExpr

Show on GitHub


                    
                    
                    FunctionCallExpr

A function call.

Declaration

Swift

public struct FunctionCallExpr : Expr

Show on GitHub


                    
                    
                    InoutExpr

An expression evaluated in place.

Declaration

Swift

public struct InoutExpr : Expr

Show on GitHub


                    
                    
                    IntegerLiteralExpr

An integer literal expression.

Declaration

Swift

public struct IntegerLiteralExpr : NumericLiteralExpr

Show on GitHub


                    
                    
                    LabeledArgument

A static argument or an argument to a function or subscript call.

Declaration

Swift

public struct LabeledArgument : Codable, Sendable

Show on GitHub


                    
                    
                    LambdaExpr

A lambda.

Declaration

Swift

public struct LambdaExpr : Expr

Show on GitHub


                    
                    
                    MapLiteralExpr

A map literal expression.

Declaration

Swift

public struct MapLiteralExpr : Expr

Show on GitHub


                    
                    
                    MatchCase

A case in a match expression.

Declaration

Swift

public struct MatchCase : Node, LexicalScope

Show on GitHub


                    
                    
                    MatchExpr

A match expression.

Declaration

Swift

public struct MatchExpr : Expr

Show on GitHub


                    
                    
                    NameExpr

A name denoting an object.

Declaration

Swift

public struct NameExpr : Expr

Show on GitHub


                    
                    
                    ParameterTypeExpr

A parameter in an arrow type expression.

Declaration

Swift

public struct ParameterTypeExpr : Expr

Show on GitHub


                    
                    
                    PragmaLiteralExpr

A value injected by the compiler.

Declaration

Swift

public struct PragmaLiteralExpr : Expr

Show on GitHub


                    
                    
                    RemoteTypeExpr

The type expression of a remote type (e.g., remote let Int).

Declaration

Swift

public struct RemoteTypeExpr : Expr

Show on GitHub


                    
                    
                    SequenceExpr

A sequence of binary operations.

Declaration

Swift

public struct SequenceExpr : Expr

Show on GitHub


                    
                    
                    SpawnExpr

An expression ran in a future.

Declaration

Swift

public struct SpawnExpr : Expr

Show on GitHub


                    
                    
                    StringLiteralExpr

A string literal expression.

Declaration

Swift

public struct StringLiteralExpr : Expr

Show on GitHub


                    
                    
                    SubscriptCallExpr

A subscript call.

Declaration

Swift

public struct SubscriptCallExpr : Expr

Show on GitHub


                    
                    
                    TupleExpr

A tuple expression.

Declaration

Swift

public struct TupleExpr : Expr

Show on GitHub


                    
                    
                    TupleMemberExpr

The expression of a tuple member, referred by its index.

Declaration

Swift

public struct TupleMemberExpr : Expr

Show on GitHub


                    
                    
                    TupleTypeExpr

A tuple type expression.

Declaration

Swift

public struct TupleTypeExpr : Expr

Show on GitHub


                    
                    
                    UnicodeScalarLiteralExpr

A unicode scalar literal expression.

Declaration

Swift

public struct UnicodeScalarLiteralExpr : Expr

extension UnicodeScalarLiteralExpr: Codable

Show on GitHub


                    
                    
                    WildcardExpr

A wildcard expression.

Declaration

Swift

public struct WildcardExpr : Expr

Show on GitHub


                    
                    
                    Introduced

A node and the site of its introducer in program sources.

Declaration

Swift

public struct Introduced<T> : Codable, Sendable where T : NodeIDProtocol

Show on GitHub


                    
                    
                    LexicalScopeSequence

A sequence of lexical scopes, from inner to outer.

Declaration

Swift

public struct LexicalScopeSequence : IteratorProtocol, Sequence

Show on GitHub


                    
                    
                    Name

An unqualified name denoting an entity.

Declaration

Swift

public struct Name : Hashable, Codable, Sendable

extension Name: CustomStringConvertible

extension Name: ExpressibleByStringLiteral

Show on GitHub


                    
                    
                    SourceRepresentable

A part of an AST node that may have a textual representation in source code.

Note

The site is a non-salient annotation. It does not contribute to a node’s value.

Declaration

Swift

public struct SourceRepresentable<Part>

extension SourceRepresentable: Sendable where Part: Sendable

extension SourceRepresentable: Equatable where Part: Equatable

extension SourceRepresentable: Hashable where Part: Hashable

extension SourceRepresentable: Codable where Part: Codable

Show on GitHub


                    
                    
                    AnyNodeID

The type-erased ID of a node.

Declaration

Swift

public struct AnyNodeID : NodeIDProtocol

extension AnyNodeID: Hashable

Show on GitHub


                    
                    
                    NodeID

The ID of a node in an AST.

Declaration

Swift

public struct NodeID<Subject> : ConcreteNodeID where Subject : Node

extension NodeID: DeclID where Subject: Decl

extension NodeID: ExprID where Subject: Expr

extension NodeID: PatternID where Subject: Pattern

extension NodeID: ScopeID where Subject: LexicalScope

extension NodeID: StmtID where Subject: Stmt

Show on GitHub


                    
                    
                    AnyDeclID

The type-erased ID of a declaration.

Declaration

Swift

public struct AnyDeclID : DeclID

Show on GitHub


                    
                    
                    DeclIDs

A collection of declaration identifiers.

Declaration

Swift

public struct DeclIDs : Sendable

extension DeclIDs: Equatable

extension DeclIDs: RandomAccessCollection

Show on GitHub


                    
                    
                    AnyExprID

The type-erased ID of a value expression.

Declaration

Swift

public struct AnyExprID : ExprID

Show on GitHub


                    
                    
                    NodeRawIdentity

The type of a node ID’s raw value.

Declaration

Swift

public struct NodeRawIdentity : Hashable, Codable, Sendable

extension NodeRawIdentity: Comparable

extension NodeRawIdentity: ExpressibleByIntegerLiteral

extension NodeRawIdentity: CustomStringConvertible

Show on GitHub


                    
                    
                    NodeKind

The type of an AST node; a nominal wrapper for Node.Type that adds conformances and convenience APIs.

Declaration

Swift

public struct NodeKind : Codable, Sendable

extension NodeKind: Hashable

extension NodeKind: Equatable

extension NodeKind: CustomStringConvertible

Show on GitHub


                    
                    
                    AnyPatternID

The type-erased ID of a pattern.

Declaration

Swift

public struct AnyPatternID : PatternID

Show on GitHub


                    
                    
                    AnyScopeID

The type-erased ID of a node outlining a lexical scope.

Declaration

Swift

public struct AnyScopeID : ScopeID

Show on GitHub


                    
                    
                    AnyStmtID

The type-erased ID of a statement.

Declaration

Swift

public struct AnyStmtID : StmtID

Show on GitHub


                    
                    
                    BindingPattern

A pattern that introduces new variables.

This pattern alters the semantics of its sub-pattern. Nested name patterns create new variable bindings, instead of referring to existing declarations.

Declaration

Swift

public struct BindingPattern : Pattern

Show on GitHub


                    
                    
                    ExprPattern

A pattern that matches the value of an equatable expression.

Declaration

Swift

public struct ExprPattern : Pattern

Show on GitHub


                    
                    
                    NamePattern

A pattern which binds an identifier.

Declaration

Swift

public struct NamePattern : Pattern

Show on GitHub


                    
                    
                    OptionPattern

A pattern that matches the presence of a value in an optional.

Declaration

Swift

public struct OptionPattern : Pattern

Show on GitHub


                    
                    
                    TuplePattern

A tuple pattern.

Declaration

Swift

public struct TuplePattern : Pattern

Show on GitHub


                    
                    
                    WildcardPattern

A wildcard pattern.

Declaration

Swift

public struct WildcardPattern : Pattern

Show on GitHub


                    
                    
                    RequirementSequence

A sequence with the requirements of a trait declaration.

Declaration

Swift

public struct RequirementSequence : IteratorProtocol, Sequence, Sendable

Show on GitHub


                    
                    
                    AssignStmt

An assignment statement.

Declaration

Swift

public struct AssignStmt : Stmt

Show on GitHub


                    
                    
                    BraceStmt

A brace statement (a.k.a. a code block).

Declaration

Swift

public struct BraceStmt : Stmt, LexicalScope

Show on GitHub


                    
                    
                    BreakStmt

A break statement.

Declaration

Swift

public struct BreakStmt : Stmt

Show on GitHub


                    
                    
                    ConditionalBindingStmt

A binding to a pattern that breaks control flow if the scrutinee doesn’t match.

Declaration

Swift

public struct ConditionalBindingStmt : Stmt

Show on GitHub


                    
                    
                    ConditionalCompilationStmt

A conditional-compilation statement.

Declaration

Swift

public struct ConditionalCompilationStmt : Stmt

Show on GitHub


                    
                    
                    ConditionalStmt

A conditional statement.

Unlike a ConditionalExpr, the branches of a conditional statement are represented by brace statements. Further, a conditional statement might not have a failure branch.

Declaration

Swift

public struct ConditionalStmt : Stmt, LexicalScope

Show on GitHub


                    
                    
                    ContinueStmt

A continue statement.

Declaration

Swift

public struct ContinueStmt : Stmt

Show on GitHub


                    
                    
                    DeclStmt

A declaration statement.

Declaration

Swift

public struct DeclStmt : Stmt

Show on GitHub


                    
                    
                    DiscardStmt

A discard statement.

Declaration

Swift

public struct DiscardStmt : Stmt

Show on GitHub


                    
                    
                    DoWhileStmt

A do-while loop.

Declaration

Swift

public struct DoWhileStmt : Stmt

Show on GitHub


                    
                    
                    ExprStmt

An expression statement.

Declaration

Swift

public struct ExprStmt : Stmt

Show on GitHub


                    
                    
                    ForStmt

A for loop.

Declaration

Swift

public struct ForStmt : Stmt, LexicalScope

Show on GitHub


                    
                    
                    ReturnStmt

A return statement.

Declaration

Swift

public struct ReturnStmt : Stmt

Show on GitHub


                    
                    
                    WhileStmt

A while loop.

Declaration

Swift

public struct WhileStmt : Stmt, LexicalScope

Show on GitHub


                    
                    
                    YieldStmt

A yield statement.

Declaration

Swift

public struct YieldStmt : Stmt

Show on GitHub


                    
                    
                    AccessEffectSet

A set of access effects.

Declaration

Swift

public struct AccessEffectSet : OptionSet, Hashable, Sendable

extension AccessEffectSet: CustomStringConvertible

Show on GitHub


                    
                    
                    GenericArguments

A map from generic parameter to its argument.

Declaration

Swift

public struct GenericArguments : Hashable, Sendable

extension GenericArguments: Collection

extension GenericArguments: CustomStringConvertible

Show on GitHub


                    
                    
                    ValueFlags

Properties about the representation of a type or term.

Declaration

Swift

public struct ValueFlags : Hashable, OptionSet, Sendable

Show on GitHub


                    
                    
                    ConditionalCompilationFactors

The factors that influence conditional compilation.

Declaration

Swift

public struct ConditionalCompilationFactors : Codable, Equatable, Hashable, Sendable

Show on GitHub


                    
                    
                    Conformance

Where, how, and under what conditions a type satisfies the requirements of a trait.

Declaration

Swift

public struct Conformance : Sendable

extension Conformance: Equatable

extension Conformance: Hashable

Show on GitHub


                    
                    
                    ConformanceOrigin

The declaration and site from which an explicit conformance originates.

Declaration

Swift

public struct ConformanceOrigin : Sendable

extension ConformanceOrigin: Hashable

Show on GitHub


                    
                    
                    DiagnosticSet

A set of Diagnostic that can answer the question “was there an error?” in O(1).

Declaration

Swift

public struct DiagnosticSet : Error, Sendable

extension DiagnosticSet: ExpressibleByArrayLiteral

extension DiagnosticSet: CustomStringConvertible

extension DiagnosticSet: Equatable

Show on GitHub


                    
                    
                    Module_

A module within a program representation P.

Declaration

Swift

public struct Module_<P>

Show on GitHub


                    
                    
                    AnyType

The (static) type of an entity.

Declaration

Swift

public struct AnyType : Sendable

extension AnyType: Monotonic

extension AnyType: TypeProtocol

extension AnyType: Equatable

extension AnyType: Hashable

extension AnyType: CustomStringConvertible

Show on GitHub


                    
                    
                    GenericEnvironment

Context to interpret the generic parameters of a declaration.

Declaration

Swift

public struct GenericEnvironment : Sendable

extension GenericEnvironment: Monotonic

extension GenericEnvironment: Equatable

Show on GitHub


                    
                    
                    FunctionAttributes

The attributes of a function surfaced for its API.

Declaration

Swift

public struct FunctionAttributes : Hashable, Sendable

extension FunctionAttributes: Monotonic

Show on GitHub


                    
                    
                    Lexer

A type that tokenize a source file.

Declaration

Swift

public struct Lexer : IteratorProtocol, Sequence, Sendable

Show on GitHub


                    
                    
                    DeclPrologue

The attributes and modifiers preceding a declaration.

Declaration

Swift

struct DeclPrologue

Show on GitHub


                    
                    
                    FunctionDeclHead

The parsed head of a function declaration.

Declaration

Swift

struct FunctionDeclHead

Show on GitHub


                    
                    
                    FunctionDeclSignature

The parsed signature of a function declaration.

Declaration

Swift

struct FunctionDeclSignature

Show on GitHub


                    
                    
                    SubscriptDeclHead

The parsed head of a subscript declaration.

Declaration

Swift

struct SubscriptDeclHead

Show on GitHub


                    
                    
                    PropertyDeclHead

The parsed head of a property declaration.

Declaration

Swift

struct PropertyDeclHead

Show on GitHub


                    
                    
                    SubscriptDeclSignature

The parsed signature of a subscript declaration.

Declaration

Swift

struct SubscriptDeclSignature

Show on GitHub


                    
                    
                    NameExprComponent

The parsed component of a name expression.

Declaration

Swift

struct NameExprComponent

Show on GitHub


                    
                    
                    ParameterInterface

The name and argument label of a parameter declaration.

Declaration

Swift

struct ParameterInterface

Show on GitHub


                    
                    
                    TakeKind

A combinator that parses tokens with a specific kind.

Declaration

Swift

struct TakeKind : Combinator

Show on GitHub


                    
                    
                    ContextualKeyword

A combinator that parses contextual keywords.

Declaration

Swift

struct ContextualKeyword<T> : Combinator where T : RawRepresentable, T.RawValue == String

Show on GitHub


                    
                    
                    WrapInContext

A combinator that updates the parsing contexts.

Declaration

Swift

struct WrapInContext<Base> : Combinator where Base : Combinator, Base.Context == ParserState

Show on GitHub


                    
                    
                    DelimitedCommaSeparatedList

A combinator that parses comma-separated lists of elements delimited by tokens on both ends.

Declaration

Swift

struct DelimitedCommaSeparatedList<E> : Combinator where E : Combinator, E.Context == ParserState

Show on GitHub


                    
                    
                    ParserState

A type representing the state of the parser.

Declaration

Swift

struct ParserState : Sendable

extension ParserState: Restorable

Show on GitHub


                    
                    
                    Token

A terminal symbol of the syntactic grammar.

Declaration

Swift

public struct Token : Sendable

Show on GitHub


                    
                    
                    ScopedProgram

A data structure representing a scoped Hylo program ready to be type checked.

Declaration

Swift

public struct ScopedProgram : Program

Show on GitHub


                    
                    
                    ScopeVisitor

The state of the visitor building scope relationships.

Declaration

Swift

private struct ScopeVisitor : ASTWalkObserver

Show on GitHub


                    
                    
                    ScopedValue

A value bundled with a lexical scope.

Declaration

Swift

public struct ScopedValue<Value>

extension ScopedValue: Sendable where Value: Sendable

extension ScopedValue: Equatable where Value: Equatable

extension ScopedValue: Hashable where Value: Hashable

Show on GitHub


                    
                    
                    SemanticVersion

A semantic version number.

Declaration

Swift

public struct SemanticVersion : Codable, Comparable, Hashable, Sendable

Show on GitHub


                    
                    
                    SourceFile

A Hylo source file, a synthesized fragment of Hylo source, or a fragment Hylo source embedded in a Swift string literal.

Declaration

Swift

public struct SourceFile : Sendable

extension SourceFile: ExpressibleByStringLiteral

extension SourceFile: Hashable

extension SourceFile: Codable

extension SourceFile: CustomStringConvertible

Show on GitHub


                    
                    
                    SourceLine

A line of a source file.

Declaration

Swift

public struct SourceLine : Hashable, Sendable

extension SourceLine: CustomStringConvertible

Show on GitHub


                    
                    
                    SourcePosition

A character boundary in a source file.

Declaration

Swift

public struct SourcePosition : Hashable, Sendable

extension SourcePosition: Comparable

extension SourcePosition: Codable

extension SourcePosition: CustomStringConvertible

Show on GitHub


                    
                    
                    SourceRange

A half-open range of textual positions in a source file.

Declaration

Swift

public struct SourceRange : Hashable, Sendable

extension SourceRange: Codable

extension SourceRange: CustomStringConvertible

Show on GitHub


                    
                    
                    ConcreteTermBox

A box wrapping an instance of Base.

Declaration

Swift

private struct ConcreteTermBox<Base> : TermBox where Base : TermProtocol

Show on GitHub


                    
                    
                    AnyTerm

The compile-time representation of the value of an expression.

Declaration

Swift

public struct AnyTerm : Sendable

extension AnyTerm: TermProtocol

extension AnyTerm: Equatable

extension AnyTerm: Hashable

extension AnyTerm: CustomStringConvertible

Show on GitHub


                    
                    
                    ConcreteTerm

A box wrapping a concrete compile-time value.

Declaration

Swift

public struct ConcreteTerm : TermProtocol

extension ConcreteTerm: CustomStringConvertible

Show on GitHub


                    
                    
                    ErrorTerm

A term denoting a type checking error.

Declaration

Swift

public struct ErrorTerm : TermProtocol

extension ErrorTerm: CustomStringConvertible

Show on GitHub


                    
                    
                    GenericTermParameter

A generic type parameter.

Declaration

Swift

public struct GenericTermParameter : TermProtocol

extension GenericTermParameter: CustomStringConvertible

Show on GitHub


                    
                    
                    TermVariable

A term variable.

Declaration

Swift

public struct TermVariable : TermProtocol

extension TermVariable: CustomStringConvertible

Show on GitHub


                    
                    
                    ConstraintSystem

A collection of constraints over a set of open type variables and a set of unresolved name expressions.

Declaration

Swift

struct ConstraintSystem

Show on GitHub


                    
                    
                    Explorations

A set of constraint system solutions resulting from the explorations of the different choices of a disjunctive constraint.

Declaration

Swift

private struct Explorations<T> where T : DisjunctiveConstraintProtocol

Show on GitHub


                    
                    
                    CallConstraint

A constraint F(A1, ..., An) -> R or F[A1, ..., An]: R specifying that F is the type of a callable object that returns or projects (respectively) instances of R when called with arguments of types A1, ..., An.

Declaration

Swift

struct CallConstraint : Constraint, Hashable, Sendable

extension CallConstraint: CustomStringConvertible

Show on GitHub


                    
                    
                    ConformanceConstraint

A constraint L : T specifying that L conforms to trait T.

Declaration

Swift

struct ConformanceConstraint : Constraint, Hashable, Sendable

extension ConformanceConstraint: CustomStringConvertible

Show on GitHub


                    
                    
                    ConstraintOrigin

The site from which a constraint originates and the reason why it was formed.

Declaration

Swift

struct ConstraintOrigin : Hashable, Sendable

extension ConstraintOrigin: CustomStringConvertible

Show on GitHub


                    
                    
                    ConstraintHashableWitness

A type serving as a witness for Constraints conformance to Hashable.

Declaration

Swift

struct ConstraintHashableWitness : HashableWitness, Sendable

Show on GitHub


                    
                    
                    DisjunctionConstraint

A disjunction of two or more constraint sets.

Declaration

Swift

struct DisjunctionConstraint : DisjunctiveConstraintProtocol, Hashable, Sendable

extension DisjunctionConstraint: CustomStringConvertible

Show on GitHub


                    
                    
                    EqualityConstraint

A constraint L == R specifying that L is exactly the same type as R.

Declaration

Swift

struct EqualityConstraint : Constraint, Hashable, Sendable

extension EqualityConstraint: CustomStringConvertible

Show on GitHub


                    
                    
                    MemberConstraint

A constraint L.m == R specifying that L has a member of type R named m.

Declaration

Swift

struct MemberConstraint : Constraint, Hashable, Sendable

extension MemberConstraint: CustomStringConvertible

Show on GitHub


                    
                    
                    MergingConstraint

A constraint L :> (R1, ..., Rn) specifying that L is the type of a conditional or match expression whose branches have types R1, ..., Rn.

Declaration

Swift

struct MergingConstraint : Constraint, Hashable, Sendable

extension MergingConstraint: CustomStringConvertible

Show on GitHub


                    
                    
                    OverloadConstraint

A constraint specifying that a name expression refers to one of several declarations, depending on its type.

Declaration

Swift

struct OverloadConstraint : DisjunctiveConstraintProtocol, Hashable, Sendable

extension OverloadConstraint: CustomStringConvertible

Show on GitHub


                    
                    
                    ParameterConstraint

A constraint L ⤷ R specifying that R is the type of a parameter and L the type of an argument that may be passed to that parameter.

Note

Solving a constraint l ⤷ R where R is a type variable requires that there be another constraint on R fixing its parameter passing convention.

Declaration

Swift

struct ParameterConstraint : Constraint, Hashable

extension ParameterConstraint: CustomStringConvertible

Show on GitHub


                    
                    
                    PredicateConstraint

A constraint that consists of an arbitrary expression that must evaluate to true.

Declaration

Swift

struct PredicateConstraint : Constraint, Hashable

extension PredicateConstraint: CustomStringConvertible

Show on GitHub


                    
                    
                    SubtypingConstraint

A constraint L <: R (or L < R) specifying that L is subtype (or strict subtype) of R.

Warning

should not be used directly for inference purposes or the type checker will get stuck. Use inferenceConstraint(_:isSubtypeOf:origin:) instead.

Declaration

Swift

struct SubtypingConstraint : Constraint, Hashable

extension SubtypingConstraint: CustomStringConvertible

Show on GitHub


                    
                    
                    TupleMemberConstraint

A constraint L.i == R stating that L is a tuple type whose i-th element has type R.

Declaration

Swift

struct TupleMemberConstraint : Constraint, Hashable

extension TupleMemberConstraint: CustomStringConvertible

Show on GitHub


                    
                    
                    InstantiatedType

A type whose generic parameters have been substituted by variables along with the constraints related to these variables.

Declaration

Swift

struct InstantiatedType : Hashable, Sendable

Show on GitHub


                    
                    
                    NameResolutionContext

The context in which a component of a name expression gets resolved.

This structure is used during name resolution to identify the type of which an entity is member and the generic arguments captured by that entity.

Declaration

Swift

struct NameResolutionContext : Sendable

Show on GitHub


                    
                    
                    ProofObligations

A set of formulae to be proven for type checking a declaration, expression, or pattern.

Declaration

Swift

struct ProofObligations : Sendable

Show on GitHub


                    
                    
                    RefinementClosure

A subset of a program’s refinement relation containing all the bases of a single trait.

Declaration

Swift

struct RefinementClosure : Equatable, Sendable

Show on GitHub


                    
                    
                    RefinementSequence

The traits of a refinement closure sorted in topological order w.r.t. to their refinements.

The sequence is ordered such that a trait t always occur after the traits which it refines. Hence the last element of the sequence is the most refined trait of the closure.

Declaration

Swift

struct RefinementSequence : IteratorProtocol, Sequence, Sendable

Show on GitHub


                    
                    
                    RequirementPrinter

An object creating textual descriptions of requirement rewriting systems.

Declaration

Swift

struct RequirementPrinter : Sendable

Show on GitHub


                    
                    
                    TypedProgram

A data structure representing a typed Hylo program ready to be lowered.

Declaration

Swift

public struct TypedProgram : Sendable

extension TypedProgram: Program

Show on GitHub


                    
                    
                    RequirementTerm

A term corresponding to a type or trait in a generic requirement.

Declaration

Swift

struct RequirementTerm : RewritingTerm

extension RequirementTerm: ExpressibleByArrayLiteral

extension RequirementTerm: Collection

Show on GitHub


                    
                    
                    RewritingRule

A rule in a rewriting system.

Declaration

Swift

struct RewritingRule<Term> : Equatable, Sendable where Term : RewritingTerm

Show on GitHub


                    
                    
                    RequirementRuleFlags

A set of flags associated with a rewriting rule.

Declaration

Swift

struct RequirementRuleFlags : OptionSet, Sendable

Show on GitHub


                    
                    
                    RewritingSystem

A set of rewriting rules describing some equational equivalences.

Declaration

Swift

struct RewritingSystem<Term> : Sendable where Term : RewritingTerm

Show on GitHub


                    
                    
                    Solution

A solution returned by a constraint solver.

Declaration

Swift

struct Solution : Sendable

extension Solution: CustomStringConvertible

Show on GitHub


                    
                    
                    SubstitutionMap

A substitution table mapping type and term variables to assumptions during inference.

Declaration

Swift

struct SubstitutionMap : Sendable

extension SubstitutionMap: CustomStringConvertible

Show on GitHub


                    
                    
                    TypeChecker

The transformation from a ScopedProgram to a TypedProgram.

Note

A method named with a leading underscore are meant be called only by the method with the same name but without that leading underscore. The former typically implement the actual computation of a value that is memoized by the latter.

Declaration

Swift

struct TypeChecker : Sendable

Show on GitHub


                    
                    
                    RecursiveReferenceRecognizer

An AST visitation callback that collects recursive references to specific declarations.

Declaration

Swift

private struct RecursiveReferenceRecognizer : ASTWalkObserver

Show on GitHub


                    
                    
                    ConcreteTypeBox

A box wrapping an instance of Base.

Declaration

Swift

private struct ConcreteTypeBox<Base> : TypeBox where Base : TypeProtocol

Show on GitHub


                    
                    
                    ArrowType

A type expressed with an arrow.

Declaration

Swift

public struct ArrowType : TypeProtocol

extension ArrowType: CallableType

extension ArrowType: CustomStringConvertible

Show on GitHub


                    
                    
                    AssociatedTypeType

An associated type of a generic type parameter, or associated type thereof.

Declaration

Swift

public struct AssociatedTypeType : TypeProtocol

extension AssociatedTypeType: CustomStringConvertible

Show on GitHub


                    
                    
                    AssociatedValueType

The type of an associated value of a generic type parameter, or associated type thereof.

Declaration

Swift

public struct AssociatedValueType : TypeProtocol

extension AssociatedValueType: CustomStringConvertible

Show on GitHub


                    
                    
                    BoundGenericType

A generic type bound to arguments.

Declaration

Swift

public struct BoundGenericType : TypeProtocol

extension BoundGenericType: Equatable

extension BoundGenericType: Hashable

extension BoundGenericType: CustomStringConvertible

Show on GitHub


                    
                    
                    BufferType

The type of a buffer.

Declaration

Swift

public struct BufferType : TypeProtocol

extension BufferType: CustomStringConvertible

Show on GitHub


                    
                    
                    CallableTypeParameter

A parameter in a callable type.

Declaration

Swift

public struct CallableTypeParameter : Hashable, Sendable

extension CallableTypeParameter: CustomStringConvertible

Show on GitHub


                    
                    
                    ConformanceLensType

A wrapper around a type that is seen through the lens of its conformance to a trait.

Declaration

Swift

public struct ConformanceLensType : TypeProtocol

extension ConformanceLensType: CustomStringConvertible

Show on GitHub


                    
                    
                    ErrorType

A type denoting a type checking error.

Declaration

Swift

public struct ErrorType : TypeProtocol

extension ErrorType: CustomStringConvertible

Show on GitHub


                    
                    
                    ExistentialType

An existential type, optionally bound by traits and constraints on associated types.

Declaration

Swift

public struct ExistentialType : TypeProtocol

extension ExistentialType: CustomStringConvertible

Show on GitHub


                    
                    
                    GenericConstraint

A constraint on generic type and value parameters.

Declaration

Swift

public struct GenericConstraint : Hashable, Sendable

extension GenericConstraint: CustomStringConvertible

Show on GitHub


                    
                    
                    GenericTypeParameterType

A generic type parameter.

Declaration

Swift

public struct GenericTypeParameterType : TypeProtocol

extension GenericTypeParameterType: CustomStringConvertible

Show on GitHub


                    
                    
                    MetatypeType

The type of a type.

Declaration

Swift

public struct MetatypeType : TypeProtocol

extension MetatypeType: CustomStringConvertible

Show on GitHub


                    
                    
                    MethodType

The overarching type of a method declaration.

Declaration

Swift

public struct MethodType : TypeProtocol

extension MethodType: CallableType

extension MethodType: CustomStringConvertible

Show on GitHub


                    
                    
                    ModuleType

A module type.

Declaration

Swift

public struct ModuleType : TypeProtocol

extension ModuleType: CustomStringConvertible

Show on GitHub


                    
                    
                    NamespaceType

The type of a namespace declaration.

Declaration

Swift

public struct NamespaceType : TypeProtocol

extension NamespaceType: CustomStringConvertible

Show on GitHub


                    
                    
                    ParameterType

The type of a parameter in an arrow, method, or subscript type.

Declaration

Swift

public struct ParameterType : TypeProtocol

extension ParameterType: CustomStringConvertible

Show on GitHub


                    
                    
                    ProductType

A nominal product type.

Declaration

Swift

public struct ProductType : TypeProtocol

extension ProductType: CustomStringConvertible

Show on GitHub


                    
                    
                    RemoteType

The type of a remote part.

Declaration

Swift

public struct RemoteType : TypeProtocol

extension RemoteType: CustomStringConvertible

Show on GitHub


                    
                    
                    SubscriptImplType

The type of a subscript implementation.

Declaration

Swift

public struct SubscriptImplType : TypeProtocol

extension SubscriptImplType: CustomStringConvertible

Show on GitHub


                    
                    
                    SubscriptType

The overarching type of a subscript declaration.

Declaration

Swift

public struct SubscriptType : TypeProtocol

extension SubscriptType: CallableType

extension SubscriptType: CustomStringConvertible

Show on GitHub


                    
                    
                    TraitType

A trait type.

Declaration

Swift

public struct TraitType : TypeProtocol

extension TraitType: CustomStringConvertible

Show on GitHub


                    
                    
                    TupleType

A tuple type.

Declaration

Swift

public struct TupleType : TypeProtocol

extension TupleType: CustomStringConvertible

Show on GitHub


                    
                    
                    TypeAliasType

A type alias.

Declaration

Swift

public struct TypeAliasType : TypeProtocol

extension TypeAliasType: CustomStringConvertible

Show on GitHub


                    
                    
                    TypeVariable

A type variable.

Declaration

Swift

public struct TypeVariable : TypeProtocol

extension TypeVariable: CustomStringConvertible

Show on GitHub


                    
                    
                    UnionType

A union of types.

Declaration

Swift

public struct UnionType : TypeProtocol

extension UnionType: Hashable

extension UnionType: CustomStringConvertible

Show on GitHub


                    
                    
                    WitnessType

The type of the value stored in an existential type.

Declaration

Swift

public struct WitnessType : TypeProtocol

extension WitnessType: CustomStringConvertible

Show on GitHub