project

Documentation

Index

• Variables
• type BaseComputeConfig
• type BaseConfig
• type ComputeUnit
• type Config
  • func ConfigFromProjectPath(projPath string) (*Config, error)
  • func (p *Config) ToFile() error
• type Function
  • func FunctionFromHandler(h string, t string) (Function, error)
  • func (f *Function) RelativeHandlerPath(s *Project) (string, error)
• type HandlerConfig
• type Project
  • func FromConfig(c *Config) (*Project, error)
  • func New(config BaseConfig) *Project

Variables

var DefaultOTELCollectorVersion string

Types

type BaseComputeConfig

type BaseComputeConfig struct {
	Type string `yaml:"type"`
}

Config shared by all compute types

type BaseConfig

type BaseConfig struct {
	Name     string `yaml:"name"`
	Dir      string `yaml:"-"`
	Handlers []any  `yaml:"handlers"`
}

type ComputeUnit

type ComputeUnit struct {
	Name string `yaml:"-"`

	Type string `yaml:"-"`
}

type Config

type Config struct {
	BaseConfig       `yaml:",inline"`
	ConcreteHandlers []*HandlerConfig `yaml:"-"`
}

func ConfigFromProjectPath

func ConfigFromProjectPath(projPath string) (*Config, error)

ConfigFromProjectPath - loads the config nitric.yaml file from the project path, defaults to the current working directory

func (*Config) ToFile

func (p *Config) ToFile() error

type Function

type Function struct {
	// The location of the function handler
	Handler string `yaml:"handler"`

	ComputeUnit `yaml:",inline"`

	// The number of workers this function contains
	WorkerCount int
}

func FunctionFromHandler

func FunctionFromHandler(h string, t string) (Function, error)

func (*Function) RelativeHandlerPath

func (f *Function) RelativeHandlerPath(s *Project) (string, error)

type HandlerConfig

type HandlerConfig struct {
	BaseComputeConfig
	Match string
}

type Project

type Project struct {
	Dir       string              `yaml:"-"`
	Name      string              `yaml:"name"`
	Functions map[string]Function `yaml:"functions,omitempty"`
	History   *history.History    `yaml:"-"`
}

func FromConfig

func FromConfig(c *Config) (*Project, error)

func New

func New(config BaseConfig) *Project