starlark_type

type CursorValueFunc ¶ added in v0.19.2

type CursorValueFunc func(cursor *pb.Cursor) (starlark.Value, error)

CursorValueFunc materializes a wire cursor handle into a starlark value; supplied by the remote call path, which knows the session and provider.

type DownloadStream ¶ added in v0.18.7

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

DownloadStream is an opaque starlark value carrying a lazily produced download body. Only plugin Go code can construct one; app starlark code can just pass it through into ace.response(data=..., download=...) - it exposes no attributes, so a handler cannot fabricate or inspect one. The producer is invoked by the download response handler at response-write time, writing the body into the response buffer: the payload is never fully materialized in memory or staged to disk, and once the buffer fills a stalled client blocks the producer (TCP backpressure). Single use: a second Produce errors instead of silently sending an empty body.

func NewDownloadStream(name string, producer func(w io.Writer) error) *DownloadStream

func (d *DownloadStream) Freeze()

func (d *DownloadStream) Hash() (uint32, error)

func (d *DownloadStream) Name() string

func (d *DownloadStream) Produce(w io.Writer) error

func (d *DownloadStream) String() string

func (d *DownloadStream) Truth() starlark.Bool

func (d *DownloadStream) Type() string

type FuncRefValueFunc ¶ added in v0.19.2

type FuncRefValueFunc func(ref *sdk.FuncRef) (starlark.Value, error)

FuncRefValueFunc materializes an SDK function reference as a Starlark callable. It is supplied by plugin dispatch, which owns the module and session needed to invoke the reference.

type GoValuer ¶ added in v0.19.2

type GoValuer interface {
	ToGoValue() (any, error)
}

GoValuer converts a custom Starlark value to its application Go representation.

type Index ¶

type Index struct {
	Fields []string
	Unique bool
}

type Output ¶

type Output struct {
	Value starlark.Value
	Err   string
}

func (o Output) Attr(name string) (starlark.Value, error)

func (o Output) AttrNames() []string

func (o Output) Freeze()

func (o Output) Hash() (uint32, error)

func (o Output) String() string

func (o Output) Truth() starlark.Bool

func (o Output) Type() string

type PluginValuer ¶ added in v0.19.2

type PluginValuer interface {
	ToPluginValue(depth int) (any, error)
}

PluginValuer converts a custom Starlark value to its plugin SDK representation, for values passed from one plugin call into another.

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 is the sanitized request header view exposed as req.Headers. It
	// is built lazily by HeadersFunc on first access, since most handlers never
	// read headers and cloning the whole header map per request is expensive.
	// Set Headers directly (with HeadersFunc nil) when the value is already
	// known.
	Headers        http.Header
	HeadersFunc    func() http.Header
	RemoteIP       string
	UrlParams      map[string]string
	Form           url.Values
	Query          url.Values
	PostForm       url.Values
	UserId         string
	UserSubject    string
	UserEmail      string
	CustomPerms    []string
	AppRBACEnabled bool
	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 (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 StarlarkType ¶

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

StarlarkType represents a Starlark type created from the schema type definition.

func NewStarlarkType(name string, data map[string]starlark.Value) *StarlarkType

func (s *StarlarkType) Attr(attr string) (starlark.Value, error)

func (s *StarlarkType) AttrNames() []string

func (s *StarlarkType) Freeze()

func (s *StarlarkType) Hash() (uint32, error)

func (s *StarlarkType) SetField(name string, val starlark.Value) error

func (s *StarlarkType) String() string

func (s *StarlarkType) Truth() starlark.Bool

func (s *StarlarkType) Type() string

type StoreField ¶

type StoreField struct {
	Name    string
	Type    TypeName
	Default any
}

type StoreInfo ¶

type StoreInfo struct {
	Bytes []byte // The raw bytes for the schema.star file
	Types []StoreType
}

type StoreType ¶

type StoreType struct {
	Name    string
	Fields  []StoreField
	Indexes []Index
}

type TypeBuilder ¶

type TypeBuilder struct {
	Name   string
	Fields []StoreField
}

func (s *TypeBuilder) CreateType(thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error)

type TypeName ¶

type TypeName string

const (
	INT      TypeName = "INT"
	FLOAT    TypeName = "FLOAT"
	DATETIME TypeName = "DATETIME"
	STRING   TypeName = "STRING"
	BOOLEAN  TypeName = "BOOLEAN"
	LIST     TypeName = "LIST"
	DICT     TypeName = "DICT"
)

type WireFuncRefFunc ¶ added in v0.19.2

type WireFuncRefFunc func(ref *pb.FuncRef) (starlark.Value, error)

WireFuncRefFunc materializes a wire func ref into a starlark callable that dispatches the referenced plugin function; supplied by the remote call path. A nil WireFuncRefFunc rejects func refs (e.g. in constants).