janet

type Call ¶

type Call struct {
	Code       []byte
	SourcePath string
	Options    CallOptions
}

func CallBytes(data []byte) Call

func CallString(code string) Call

type CallOptions ¶

type CallOptions struct {
	// Whether to allow the code to mutate the current environment.
	UpdateEnv bool
}

type Callback ¶

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

type Docstrings ¶ added in v0.1.6

type Docstrings interface {
	Docstrings() map[string]string
}

Docstrings provides docstrings for module methods. This is a mapping from the method's Go name to its Janet docstring.

type Documented ¶ added in v0.1.6

type Documented interface {
	Documentation() string
}

Documented provides documentation in the form of a Markdown-formatted string. All of the lines following a top-level Markdown header with a title that matches a Go method name will be included as the Janet documentation for that method.

For example, providing a string that looks like this: ``` # doc: SomeMethod This is some documentation # doc: SomeMethodB This is some other documentation ``` Will result in SomeMethod and SomeMethodB having those docstrings.

type Fiber ¶

type Fiber struct {
	*Value
	// contains filtered or unexported fields
}

type Function ¶

type Function struct {
	*Value
	// contains filtered or unexported fields
}

func (f *Function) Call(ctx context.Context, params ...interface{}) error

func (f *Function) CallContext(
	ctx context.Context,
	user interface{},
	params ...interface{},
) error

type Keyword ¶ added in v0.1.5

type Keyword string

type Named ¶

type Named[T any] struct {
	// contains filtered or unexported fields
}

func (n *Named[T]) Values() T

func (n *Named[T]) WithDefault(defaults T) T

type Params ¶

type Params struct {
	Context context.Context
	User    interface{}
	Result  chan Result
}

func (p Params) Error(err error)

func (p Params) Ok()

func (p Params) Out(value *Value)

func (p Params) Pipe() Params

func (p Params) Wait() error

type PartialCallback ¶

type PartialCallback struct {
	Type reflect.Type
	// contains filtered or unexported fields
}

func (p *PartialCallback) Call() []reflect.Value

type Renamable ¶

type Renamable interface {
	Renames() map[string]string
}

Renamable provides a mapping from Go method names to Janet function names. This is useful for declaring Janet functions that are not valid Go, such as "boolean?".

type Request ¶

type Request interface{}

type Result ¶

type Result struct {
	Out   *Value
	Error error
}

type Table ¶

type Table struct {
	*Value
	// contains filtered or unexported fields
}

type VM ¶

type VM struct {
	deadlock.RWMutex
	// contains filtered or unexported fields
}

func New(ctx context.Context) (*VM, error)

func (v *VM) Callback(name string, docstring string, callback interface{}) error

func (v *VM) Env() *Table

func (v *VM) Execute(ctx context.Context, code string) error

func (v *VM) ExecuteCall(ctx context.Context, user interface{}, call Call) error

func (v *VM) ExecuteFile(ctx context.Context, path string) error

func (v *VM) Module(name string, module interface{}) error

func (v *VM) Unmarshal(source C.Janet, dest interface{}) error

type Value ¶

type Value struct {
	deadlock.RWMutex
	// contains filtered or unexported fields
}

func (v *Value) Free()

func (v *Value) IsFree() bool

func (v *Value) Unmarshal(dest interface{}) error