catalog

Documentation

Index

• type Catalog
  • func New(config *Config) *Catalog
  • func (c *Catalog) Add(resources ...resource.Resource)
  • func (c *Catalog) Load() error
  • func (c *Catalog) Run() error
• type Config

Types

type Catalog

type Catalog struct {
	// Unsorted contains the list of resources created by Lua
	Unsorted []resource.Resource `luar:"-"`
	// contains filtered or unexported fields
}

Catalog type contains a collection of resources

func New

func New(config *Config) *Catalog

New creates a new empty catalog with the provided configuration

func (*Catalog) Add

func (c *Catalog) Add(resources ...resource.Resource)

Add adds a resource to the catalog. This method is called from Lua when adding new resources

func (*Catalog) Load

func (c *Catalog) Load() error

Load loads resources into the catalog

func (*Catalog) Run

func (c *Catalog) Run() error

Run processes the resources from catalog

type Config

type Config struct {
	// Name of the Lua module to load and execute
	Module string

	// Do not take any actions, just report what would be done
	DryRun bool

	// Writer used to log events
	Logger *log.Logger

	// Path to the site repo containing module and data files
	SiteRepo string

	// The Lua state
	L *lua.LState

	// Number of goroutines to use for concurrent processing
	Concurrency int
}

Config type represents a set of settings to use when creating and processing the catalog