engine

Documentation

Overview

Package engine GENERATED BY gengo:enum DON'T EDIT THIS FILE

Package engine GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE

Index

• Variables
• type LogLevel
  • func ParseLogLevelLabelString(label string) (LogLevel, error)
  • func (LogLevel) EnumValues() []any
  • func (v LogLevel) Label() string
  • func (LogLevel) RuntimeDoc(names ...string) ([]string, bool)
• type Logger
  • func (l *Logger) Init(ctx context.Context) error
  • func (l *Logger) InjectContext(ctx context.Context) context.Context
  • func (v Logger) RuntimeDoc(names ...string) ([]string, bool)
  • func (l *Logger) SetDefaults()
• type OptFunc
  • func WithCacheDir(root string) OptFunc
  • func WithProject(root string) OptFunc
• type Pipeline
  • func (pipeline *Pipeline) Run(ctx context.Context) error
  • func (v Pipeline) RuntimeDoc(names ...string) ([]string, bool)
  • func (pipeline *Pipeline) SetDefaults()
• type Project
  • func New(ctx context.Context, opts ...OptFunc) (Project, error)

Variables

var InvalidLogLevel = github_com_pkg_errors.New("invalid LogLevel")

Types

type LogLevel

type LogLevel string

+gengo:enum

const (
	ErrorLevel LogLevel = "error"
	WarnLevel  LogLevel = "warn"
	InfoLevel  LogLevel = "info"
	DebugLevel LogLevel = "debug"
)

func ParseLogLevelLabelString

func ParseLogLevelLabelString(label string) (LogLevel, error)

func (LogLevel) EnumValues

func (LogLevel) EnumValues() []any

func (LogLevel) Label

func (v LogLevel) Label() string

func (LogLevel) RuntimeDoc

func (LogLevel) RuntimeDoc(names ...string) ([]string, bool)

type Logger

type Logger struct {
	// Log level
	LogLevel LogLevel `flag:",omitempty"`
	// contains filtered or unexported fields
}

func (*Logger) Init

func (l *Logger) Init(ctx context.Context) error

func (*Logger) InjectContext

func (l *Logger) InjectContext(ctx context.Context) context.Context

func (Logger) RuntimeDoc

func (v Logger) RuntimeDoc(names ...string) ([]string, bool)

func (*Logger) SetDefaults

func (l *Logger) SetDefaults()

type OptFunc

type OptFunc = func(o *option)

func WithCacheDir

func WithCacheDir(root string) OptFunc

func WithProject

func WithProject(root string) OptFunc

type Pipeline

type Pipeline struct {
	Action []string `arg:""`
	// plan root file
	// and the dir of the root file will be the cwd for all cue files
	Project string `flag:",omitempty" alias:"p"`

	// cache dir root
	// for cache files
	CacheDir string `flag:",omitempty"`
}

func (*Pipeline) Run

func (pipeline *Pipeline) Run(ctx context.Context) error

func (Pipeline) RuntimeDoc

func (v Pipeline) RuntimeDoc(names ...string) ([]string, bool)

func (*Pipeline) SetDefaults

func (pipeline *Pipeline) SetDefaults()

type Project

type Project interface {
	Run(ctx context.Context, action ...string) error
}

func New

func New(ctx context.Context, opts ...OptFunc) (Project, error)