cache

Documentation

Overview

Package cache provides parsed FSE DSLs on Open and Stat from a filesystem

Index

• type Cache
  • func New() *Cache
  • func NewWith(open OpenFunc, stat StatFunc) *Cache
  • func (c *Cache) Workflow(fn string) (*syntax.Workflow, []listener.Diagnostic, error)
  • func (c *Cache) Workflows() []*syntax.Workflow
• type ModTimer
• type OpenFunc
• type StatFunc

Types

type Cache

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

Cache stores file based DSLs cached by Stat information and indexed on filename

func New

func New() *Cache

New creates a new Cache with os.Open and os.Stat

func NewWith

func NewWith(open OpenFunc, stat StatFunc) *Cache

NewWith creates a new Cache with custom Open and Stat functions

func (*Cache) Workflow

func (c *Cache) Workflow(fn string) (*syntax.Workflow, []listener.Diagnostic, error)

Workflow returns a parsed Workflow which is the same until the unterlying file has a different ModTime

func (*Cache) Workflows

func (c *Cache) Workflows() []*syntax.Workflow

Workflows makes a snapshot of all cached workflow definitions sorted by filename

type ModTimer

type ModTimer interface {
	ModTime() time.Time // modification time
}

ModTimer has a ModTime function like the result of os.Stat

type OpenFunc

type OpenFunc func(fn string) (io.ReadCloser, error)

OpenFunc is a simpler os.Open

type StatFunc

type StatFunc func(fn string) (ModTimer, error)

StatFunc is a simpler os.Stat where only ModTime() is required