warden

Documentation

Index

• Variables
• func DefaultPreloadModules() []wlua.Module
• type Options
  • func DefaultOptions() *Options
• type Warden
  • func New(opts ...*Options) (*Warden, error)
  • func (w *Warden) Close()
  • func (w *Warden) ValidatePlan(file afero.File) ([]string, error)

Variables

var (
	ErrValidationFailed = xerrors.New("validation failed")
)

Functions

func DefaultPreloadModules

func DefaultPreloadModules() []wlua.Module

Types

type Options

type Options struct {
	Libs        []wlua.Module
	Modules     []wlua.Module
	UserModules []wlua.UserModule
	Script      string
}

func DefaultOptions

func DefaultOptions() *Options

DefaultOptions returns the default options used when creating a Warden instance with New.

type Warden

type Warden struct {
	// contains filtered or unexported fields
}

func New

func New(opts ...*Options) (*Warden, error)

New creates a new Warden instance.

func (*Warden) Close

func (w *Warden) Close()

func (*Warden) ValidatePlan

func (w *Warden) ValidatePlan(file afero.File) ([]string, error)

ValidatePlan checks the validity of the specified plan with the configured scripts.