enum

Documentation

Overview

Package enum validates closed, type-safe enum declarations from the shared typed compiler program. It never evaluates application code or emits runtime registries.

Index

• type Catalog
  • func Build(program *load.Program, resolution resolve.Result) Catalog
  • func (catalog Catalog) Diagnostics() []Diagnostic
  • func (catalog Catalog) Types() []Type
• type Diagnostic
  • func (diagnostic Diagnostic) Error() string
• type Member
• type Type
  • func (value Type) Members() []Member

Types

type Catalog

type Catalog struct {
	// contains filtered or unexported fields
}

Catalog is the immutable enum validation result.

func Build

func Build(program *load.Program, resolution resolve.Result) Catalog

Build validates every resolved @Enum declaration without reloading source.

func (Catalog) Diagnostics

func (catalog Catalog) Diagnostics() []Diagnostic

Diagnostics returns deterministic enum diagnostics.

func (Catalog) Types

func (catalog Catalog) Types() []Type

Types returns validated enums in stable symbol order.

type Diagnostic

type Diagnostic struct {
	Position         token.Position
	PhysicalPosition token.Position
	SymbolID         string
	Kind             string
	Message          string
}

Diagnostic is one deterministic enum validation failure.

func (Diagnostic) Error

func (diagnostic Diagnostic) Error() string

Error renders a compiler-style diagnostic.

type Member

type Member struct {
	Name             string
	Value            string
	Position         token.Position
	PhysicalPosition token.Position
}

Member is one declared member of a closed enum.

type Type

type Type struct {
	Symbol           load.Symbol
	SymbolID         string
	Name             string
	PackagePath      string
	Type             types.Type
	TypeID           string
	Underlying       string
	Position         token.Position
	PhysicalPosition token.Position
	// contains filtered or unexported fields
}

Type is one validated @Enum declaration.

func (Type) Members

func (value Type) Members() []Member

Members returns enum members in source declaration order.