est

Documentation

Overview

Package est provides the Encore Syntax Tree (EST).

It is an Encore-specific syntax tree that represents the higher-level representation of the application that Encore understands.

Index

• type AccessType
• type Application
• type AuthHandler
• type CronJob
  • func (cj *CronJob) IsValid() (bool, error)
• type File
• type Node
• type NodeType
• type Package
• type Param
• type RPC
• type Resource
• type ResourceType
  • func (i ResourceType) String() string
• type SQLDB
  • func (r *SQLDB) File() *File
  • func (r *SQLDB) Ident() *ast.Ident
  • func (r *SQLDB) Type() ResourceType
• type Service

Types

type AccessType

type AccessType string

const (
	Public  AccessType = "public"
	Private AccessType = "private"
	// Auth is like public but requires authentication.
	Auth AccessType = "auth"
)

type Application

type Application struct {
	ModulePath  string
	Packages    []*Package
	Services    []*Service
	CronJobs    []*CronJob
	Decls       []*schema.Decl
	AuthHandler *AuthHandler
}

type AuthHandler

type AuthHandler struct {
	Svc    *Service
	Name   string
	Doc    string
	Func   *ast.FuncDecl
	File   *File
	Params *schema.Type // builtin string or named type

	// AuthData is the custom auth data type the app may specify
	// as part of the returns from the auth handler.
	// It is nil if no such auth data type is specified.
	AuthData *Param
}

type CronJob

type CronJob struct {
	ID       string
	Title    string
	Doc      string
	Schedule string
	RPC      *RPC
	AST      *ast.ValueSpec
}

func (*CronJob) IsValid

func (cj *CronJob) IsValid() (bool, error)

type File

type File struct {
	Name       string   // file name ("foo.go")
	Pkg        *Package // package it belongs to
	Path       string   // filesystem path
	AST        *ast.File
	Token      *token.File
	Contents   []byte
	References map[ast.Node]*Node
}

type Node

type Node struct {
	Type NodeType
	// If Type == RPCDefNode or RPCCallNode,
	// RPC is the RPC being defined or called.
	RPC *RPC

	// If Type == SQLDBNode or RLogNode,
	// Func is the func name being called.
	Func string

	// Resource this refers to, if any
	Res Resource
}

type NodeType

type NodeType int

const (
	RPCDefNode NodeType = iota + 1
	RPCRefNode
	SQLDBNode
	RLogNode
	SecretsNode
)

type Package

type Package struct {
	AST        *ast.Package
	Name       string
	Doc        string
	ImportPath string // import path
	RelPath    string // import path relative to app root
	Dir        string // filesystem path
	Files      []*File
	Service    *Service // the service this package belongs to, if any
	Secrets    []string
	Resources  []Resource
}

type Param

type Param struct {
	IsPtr bool
	Type  *schema.Type
}

type RPC

type RPC struct {
	Svc         *Service
	Name        string
	Doc         string
	Func        *ast.FuncDecl
	File        *File
	Access      AccessType
	Raw         bool
	Path        *paths.Path
	HTTPMethods []string
	Request     *Param // request data; nil for Raw RPCs
	Response    *Param // response data; nil for Raw RPCs
}

type Resource

type Resource interface {
	Type() ResourceType
	File() *File
	Ident() *ast.Ident
}

type ResourceType

type ResourceType int

const (
	SQLDBResource ResourceType = iota + 1
)

func (ResourceType) String

func (i ResourceType) String() string

type SQLDB

type SQLDB struct {
	DeclFile *File
	DeclName *ast.Ident // where the resource is declared
	DBName   string
}

func (*SQLDB) File

func (r *SQLDB) File() *File

func (*SQLDB) Ident

func (r *SQLDB) Ident() *ast.Ident

func (*SQLDB) Type

func (r *SQLDB) Type() ResourceType

type Service

type Service struct {
	Name string
	Root *Package
	Pkgs []*Package
	RPCs []*RPC
}

A Service is a Go package that defines one or more RPCs. Its name is defined by the Go package name. A Service may not be a located in a child directory of another service.