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
  • func (a *Application) MatchingMiddleware(rpc *RPC) []*Middleware
• type AuthHandler
• type CronJob
  • func (cj *CronJob) AllowOnlyParsedUsage() bool
  • func (cj *CronJob) File() *File
  • func (cj *CronJob) Ident() *ast.Ident
  • func (cj *CronJob) IsValid() (bool, error)
  • func (cj *CronJob) NodeType() NodeType
  • func (cj *CronJob) Type() ResourceType
• type File
• type Middleware
• type Node
• type NodeType
• type Package
• type Param
• type PubSubGuarantee
• type PubSubPublisher
• type PubSubSubscriber
  • func (p *PubSubSubscriber) AllowOnlyParsedUsage() bool
  • func (p *PubSubSubscriber) File() *File
  • func (p *PubSubSubscriber) Ident() *ast.Ident
  • func (p *PubSubSubscriber) NodeType() NodeType
  • func (p *PubSubSubscriber) Type() ResourceType
• type PubSubTopic
  • func (p *PubSubTopic) AllowOnlyParsedUsage() bool
  • func (p *PubSubTopic) File() *File
  • func (p *PubSubTopic) Ident() *ast.Ident
  • func (p *PubSubTopic) NodeType() NodeType
  • func (p *PubSubTopic) Type() ResourceType
• type RPC
• type Resource
• type ResourceType
  • func (i ResourceType) String() string
• type SQLDB
  • func (r *SQLDB) AllowOnlyParsedUsage() bool
  • func (r *SQLDB) File() *File
  • func (r *SQLDB) Ident() *ast.Ident
  • func (r *SQLDB) NodeType() NodeType
  • func (r *SQLDB) Type() ResourceType
• type Service
• type ServiceStruct

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
	PubSubTopics []*PubSubTopic
	Decls        []*schema.Decl
	AuthHandler  *AuthHandler
	Middleware   []*Middleware
}

func (*Application) MatchingMiddleware

func (a *Application) MatchingMiddleware(rpc *RPC) []*Middleware

MatchingMiddleware reports which middleware applies to the given RPC, and the order they apply in.

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
	DeclFile *File
	AST      *ast.Ident
}

func (*CronJob) AllowOnlyParsedUsage

func (cj *CronJob) AllowOnlyParsedUsage() bool

func (*CronJob) File

func (cj *CronJob) File() *File

func (*CronJob) Ident

func (cj *CronJob) Ident() *ast.Ident

func (*CronJob) IsValid

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

func (*CronJob) NodeType

func (cj *CronJob) NodeType() NodeType

func (*CronJob) Type

func (cj *CronJob) Type() ResourceType

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 Middleware

type Middleware struct {
	Name   string
	Doc    string
	Global bool
	Target selector.Set

	Func *ast.FuncDecl
	File *File

	Pkg       *Package       // pkg this middleware is defined in
	Svc       *Service       // nil if global
	SvcStruct *ServiceStruct // nil if not defined on a service struct
}

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
	CronJobNode
	PubSubTopicDefNode
	PubSubPublisherNode
	PubSubSubscriberNode
)

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 PubSubGuarantee

type PubSubGuarantee int

const (
	AtLeastOnce PubSubGuarantee = iota
	ExactlyOnce
)

type PubSubPublisher

type PubSubPublisher struct {
	DeclFile *File // The file the publisher is declared in
}

type PubSubSubscriber

type PubSubSubscriber struct {
	Name     string       // The unique name of the subscriber
	Topic    *PubSubTopic // The topic the subscriber is registered against
	CallSite ast.Node     // The AST node representing the creation of the subscriber
	Func     ast.Node     // The function that is the subscriber (either a *ast.FuncLit or a *ast.FuncDecl)
	FuncFile *File        // The file the subscriber function is declared in
	DeclFile *File        // The file that the subscriber is defined in
	IdentAST *ast.Ident   // The AST node representing the value this topic is bound against

	AckDeadline      time.Duration
	MessageRetention time.Duration
	MinRetryBackoff  time.Duration
	MaxRetryBackoff  time.Duration
	MaxRetries       int64 // number of attempts
}

func (*PubSubSubscriber) AllowOnlyParsedUsage

func (p *PubSubSubscriber) AllowOnlyParsedUsage() bool

func (*PubSubSubscriber) File

func (p *PubSubSubscriber) File() *File

func (*PubSubSubscriber) Ident

func (p *PubSubSubscriber) Ident() *ast.Ident

func (*PubSubSubscriber) NodeType

func (p *PubSubSubscriber) NodeType() NodeType

func (*PubSubSubscriber) Type

func (p *PubSubSubscriber) Type() ResourceType

type PubSubTopic

type PubSubTopic struct {
	Name              string          // The unique name of the pub sub topic
	Doc               string          // The documentation on the pub sub topic
	DeliveryGuarantee PubSubGuarantee // What guarantees does the pub sub topic have?
	OrderingKey       string          // What field in the message type should be used to ensure First-In-First-Out (FIFO) for messages with the same key
	DeclFile          *File           // What file the topic is declared in
	MessageType       *Param          // The message type of the pub sub topic
	IdentAST          *ast.Ident      // The AST node representing the value this topic is bound against

	Subscribers []*PubSubSubscriber
	Publishers  []*PubSubPublisher
}

func (*PubSubTopic) AllowOnlyParsedUsage

func (p *PubSubTopic) AllowOnlyParsedUsage() bool

func (*PubSubTopic) File

func (p *PubSubTopic) File() *File

func (*PubSubTopic) Ident

func (p *PubSubTopic) Ident() *ast.Ident

func (*PubSubTopic) NodeType

func (p *PubSubTopic) NodeType() NodeType

func (*PubSubTopic) Type

func (p *PubSubTopic) Type() ResourceType

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
	Tags        selector.Set

	// SvcStruct is the service struct this RPC is defined on,
	// or nil otherwise. It is always a pointer receiver.
	SvcStruct *ServiceStruct
}

type Resource

type Resource interface {
	Type() ResourceType
	File() *File
	Ident() *ast.Ident
	NodeType() NodeType
	AllowOnlyParsedUsage() bool // If true this resource can only be used with registered resource parsers. If false we allow any usage.
}

type ResourceType

type ResourceType int

const (
	SQLDBResource ResourceType = iota + 1
	CronJobResource
	PubSubTopicResource
	PubSubSubscriptionResource
)

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) AllowOnlyParsedUsage

func (r *SQLDB) AllowOnlyParsedUsage() bool

func (*SQLDB) File

func (r *SQLDB) File() *File

func (*SQLDB) Ident

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

func (*SQLDB) NodeType

func (r *SQLDB) NodeType() NodeType

func (*SQLDB) Type

func (r *SQLDB) Type() ResourceType

type Service

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

	// Struct is the dependency injection struct, or nil if none exists.
	Struct *ServiceStruct
}

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.

type ServiceStruct

type ServiceStruct struct {
	Name string
	Svc  *Service
	File *File // where the struct is defined
	Doc  string
	Decl *ast.TypeSpec
	RPCs []*RPC // RPCs defined on the service struct

	// Init is the function for initializing this group.
	// It is nil if there is no initialization function.
	Init     *ast.FuncDecl
	InitFile *File // where the init func is declared
}

ServiceStruct describes a dependency injection struct a particular service defines.