Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Desc ¶
type Desc struct {
Errs *perr.List
BuildInfo parsectx.BuildInfo
MainModule *pkginfo.Module
Parse *parser.Result
Services []*Service
Gateways []*Gateway
// Framework describes API Framework-specific application-global data.
Framework option.Option[*apiframework.AppDesc]
// ResourceUsageOutsideServices describes resources that are used outside of a service.
ResourceUsageOutsideServices map[resource.Resource][]usage.Usage
}
Desc describes an Encore application.
func ValidateAndDescribe ¶
ValidateAndDescribe validates the application and computes the application description.
func (*Desc) MatchingGlobalMiddleware ¶ added in v1.16.0
func (d *Desc) MatchingGlobalMiddleware(ep *api.Endpoint) []*middleware.Middleware
MatchingGlobalMiddleware reports which global middleware applies to the given RPC, and the order they apply in.
func (*Desc) MatchingMiddleware ¶
func (d *Desc) MatchingMiddleware(ep *api.Endpoint) []*middleware.Middleware
MatchingMiddleware reports which middleware applies to the given RPC, and the order they apply in.
type Gateway ¶ added in v1.33.0
type Gateway struct {
// EncoreName is the encore-name of the gateway.
EncoreName string
}
Gateway describes an Encore gateway.
type Service ¶
type Service struct {
// Name is the name of the service.
Name string
// Num is the 1-based service number in the application.
Num int
// FSRoot is the root directory of the service.
FSRoot paths.FS
// Framework contains API Framework-specific data for this service.
Framework option.Option[*apiframework.ServiceDesc]
// ResourceBinds describes the infra resources bound within the service.
ResourceBinds map[resource.Resource][]resource.Bind
// ResourceUsage describes the infra resources the service accesses and how.
ResourceUsage map[resource.Resource][]usage.Usage
}
Service describes an Encore service.
Source Files
¶
- api_framework.go
- app.go
- errors.go
- gateway.go
- resource_usage.go
- service.go
- service_discovery.go
- validate.go
- validate_apis.go
- validate_authhandlers.go
- validate_caches.go
- validate_config.go
- validate_crons.go
- validate_databases.go
- validate_middleware.go
- validate_objects.go
- validate_pubsub.go
- validate_servicestructs.go
- validate_types.go
Click to show internal directories.
Click to hide internal directories.