registry

Documentation

Index

• Variables
• func Names() []string
• func Register(f Factory) error
• type Content
• type Factory
  • func Find(name string) (Factory, bool)
  • func NewFactory(graphEntries map[string]graphs.Entry) Factory
  • func Open(name string) (Factory, error)
  • func (f *Factory) Graph(name string) (string, error)
  • func (f *Factory) GraphNames() []string
• type NewDriverFunc
• type OpenFunc
• type PrepareRunFunc
• type ProcessTemplateFunc

Variables

var UtilPackageName = "?"

Functions

func Names

func Names() []string

func Register

func Register(f Factory) error

Register a new backend.

Types

type Content

type Content struct {
	Name  string
	Lines []string
}

type Factory

type Factory struct {
	// Name is a unique key for this factory.
	Name string

	// DbPath is the location of the database for
	// any doc drivers.
	DbPath string

	// Open gets called when the factory is opened.
	Open OpenFunc

	// Prepare allows factories to modify env vars
	// before a graph is run.
	Prepare PrepareRunFunc
	// contains filtered or unexported fields
}

func Find

func Find(name string) (Factory, bool)

Find a backend.

func NewFactory

func NewFactory(graphEntries map[string]graphs.Entry) Factory

func Open

func Open(name string) (Factory, error)

Open a backend. The backend will register any required dependencies (nodes, filesystems, etc.)

func (*Factory) Graph

func (f *Factory) Graph(name string) (string, error)

func (*Factory) GraphNames

func (f *Factory) GraphNames() []string

type NewDriverFunc

type NewDriverFunc func() doc.Driver

NewDriverFunc returns a new instance of a doc.Driver.

type OpenFunc

type OpenFunc func() error

OpenFunc is called on a factory when a backend is loaded.

type PrepareRunFunc

type PrepareRunFunc func(f Factory, graphName string, vars map[string]any)

PrepareRunFunc provides factories a change to make any changes before running a graph.

type ProcessTemplateFunc

type ProcessTemplateFunc func(*Content) error