app

Documentation

Index

• Constants
• func ClearCleanup(thread *starlark.Thread, key string)
• func CreatePluginApi(f StarlarkFunction, opType PluginFunctionType) utils.PluginFunc
• func CreatePluginApiName(...) utils.PluginFunc
• func DeferCleanup(thread *starlark.Thread, key string, deferFunc DeferFunc, strict bool)
• func FetchPluginState(thread *starlark.Thread, key string) any
• func GetContext(thread *starlark.Thread) context.Context
• func RegisterPlugin(name string, builder utils.NewPluginFunc, funcs []utils.PluginFunc)
• func SavePluginState(thread *starlark.Thread, key string, value any)
• type App
  • func NewApp(sourceFS *util.SourceFs, workFS *util.WorkFs, logger *utils.Logger, ...) *App
  • func (a *App) Audit() (*utils.ApproveResult, error)
  • func (a *App) Close() error
  • func (a *App) Initialize() error
  • func (a *App) Reload(force, immediate bool) (bool, error)
  • func (a *App) ResetFS()
  • func (a *App) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type AppPlugins
  • func NewAppPlugins(app *App, pluginConfig map[string]utils.PluginSettings, ...) *AppPlugins
  • func (p *AppPlugins) GetPlugin(pluginInfo *utils.PluginInfo, accountName string) (any, error)
• type DeferEntry
• type DeferFunc
• type PluginFunctionType
• type Request
  • func (r Request) Attr(name string) (starlark.Value, error)
  • func (r Request) AttrNames() []string
  • func (r Request) Freeze()
  • func (r Request) Hash() (uint32, error)
  • func (r Request) String() string
  • func (r Request) Truth() starlark.Bool
  • func (r Request) Type() string
• type SSEMessage
• type StarlarkFunction

Constants

const (
	TL_CONTEXT                  = "TL_context"
	TL_DEFER_MAP                = "TL_defer_map"
	TL_CURRENT_MODULE_FULL_PATH = "TL_current_module_full_path"
)

Functions

func ClearCleanup

func ClearCleanup(thread *starlark.Thread, key string)

ClearCleanup clears a defer function from the thread local

func CreatePluginApi

func CreatePluginApi(f StarlarkFunction, opType PluginFunctionType) utils.PluginFunc

func CreatePluginApiName

func CreatePluginApiName(
	f func(thread *starlark.Thread, fn *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error),
	opType PluginFunctionType,
	name string) utils.PluginFunc

CreatePluginApiName creates a Clace plugin function

func DeferCleanup

func DeferCleanup(thread *starlark.Thread, key string, deferFunc DeferFunc, strict bool)

DeferCleanup defers a close function to call when the API handler is done

func FetchPluginState

func FetchPluginState(thread *starlark.Thread, key string) any

FetchPluginState fetches a value from the thread local for the plugin

func GetContext

func GetContext(thread *starlark.Thread) context.Context

func RegisterPlugin

func RegisterPlugin(name string, builder utils.NewPluginFunc, funcs []utils.PluginFunc)

RegisterPlugin registers a plugin with Clace

func SavePluginState

func SavePluginState(thread *starlark.Thread, key string, value any)

SavePluginState saves a value in the thread local for the plugin

Types

type App

type App struct {
	*utils.Logger
	*utils.AppEntry
	Name         string
	CustomLayout bool

	Config *util.AppConfig
	// contains filtered or unexported fields
}

App is the main object that represents a Clace app. It is created when the app is loaded

func NewApp

func NewApp(sourceFS *util.SourceFs, workFS *util.WorkFs, logger *utils.Logger,
	appEntry *utils.AppEntry, systemConfig *utils.SystemConfig,
	plugins map[string]utils.PluginSettings) *App

func (*App) Audit

func (a *App) Audit() (*utils.ApproveResult, error)

func (*App) Close

func (a *App) Close() error

func (*App) Initialize

func (a *App) Initialize() error

func (*App) Reload

func (a *App) Reload(force, immediate bool) (bool, error)

func (*App) ResetFS

func (a *App) ResetFS()

func (*App) ServeHTTP

func (a *App) ServeHTTP(w http.ResponseWriter, r *http.Request)

type AppPlugins

type AppPlugins struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewAppPlugins

func NewAppPlugins(app *App, pluginConfig map[string]utils.PluginSettings, appAccounts []utils.AccountLink) *AppPlugins

func (*AppPlugins) GetPlugin

func (p *AppPlugins) GetPlugin(pluginInfo *utils.PluginInfo, accountName string) (any, error)

type DeferEntry

type DeferEntry struct {
	Func   DeferFunc
	Strict bool
}

type DeferFunc

type DeferFunc func() error

type PluginFunctionType

type PluginFunctionType int

const (
	READ PluginFunctionType = iota
	WRITE
	READ_WRITE
)

type Request

type Request struct {
	AppName     string
	AppPath     string
	AppUrl      string
	PagePath    string
	PageUrl     string
	Method      string
	IsDev       bool
	IsPartial   bool
	PushEvents  bool
	HtmxVersion string
	Headers     http.Header
	RemoteIP    string
	UrlParams   map[string]string
	Form        url.Values
	Query       url.Values
	PostForm    url.Values
	Data        any
}

Request is a starlark.Value that represents an HTTP request. A Request is created from the Go http.Request and passed to the starlark handler function as it only argument. The Data field is updated with the handler's response and then the template evaluation is done with the same Request

func (Request) Attr

func (r Request) Attr(name string) (starlark.Value, error)

func (Request) AttrNames

func (r Request) AttrNames() []string

func (Request) Freeze

func (r Request) Freeze()

func (Request) Hash

func (r Request) Hash() (uint32, error)

func (Request) String

func (r Request) String() string

func (Request) Truth

func (r Request) Truth() starlark.Bool

func (Request) Type

func (r Request) Type() string

type SSEMessage

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

type StarlarkFunction

type StarlarkFunction func(thread *starlark.Thread, fn *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error)