api

package module

v1.0.0-alpha.8 Latest Latest Go to latest Published: Aug 28, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/MontFerret/api

Links

Open Source Insights

README ¶

Universal Ferret API

Documentation ¶

Index ¶

type OptimizationLevel
type Output
type Plan
type PlanOption
- func WithOptimizationLevel(level OptimizationLevel) PlanOption
type PlanOptions
type Runtime
type Session
type SessionOption
type SessionOptions
type Source

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type OptimizationLevel ¶

type OptimizationLevel int

const (
	OptimizationNone OptimizationLevel = iota
	OptimizationBasic
	OptimizationFull
	OptimizationAggressive
)

type Output ¶

type Output = result.Output

type Plan ¶

type Plan interface {
	io.Closer
	Params() []string
	NewSession(ctx context.Context, opts ...SessionOption) (Session, error)
	NewDebugSession(ctx context.Context, opts ...SessionOption) (debugger.Session, error)
}

type PlanOption ¶

type PlanOption = func(PlanOptions) error

func WithOptimizationLevel ¶

func WithOptimizationLevel(level OptimizationLevel) PlanOption

WithOptimizationLevel sets the optimization level for the execution plan.

type PlanOptions ¶

type PlanOptions interface {
	SetOptimizationLevel(OptimizationLevel) error
}

type Runtime ¶

type Runtime interface {
	io.Closer
	Run(ctx context.Context, src Source, opts ...SessionOption) (result.Output, error)
	Compile(ctx context.Context, src Source, opts ...PlanOption) (Plan, error)
	CompileDebug(ctx context.Context, src Source, opts ...PlanOption) (Plan, error)
}

type Session ¶

type Session interface {
	io.Closer
	Run(c context.Context) (result.Output, error)
}

type SessionOption ¶

type SessionOption = func(SessionOptions) error

func WithOutputContentType ¶

func WithOutputContentType(contentType string) SessionOption

WithOutputContentType selects the output codec content type for session results.

func WithParam ¶

func WithParam(key string, value any) SessionOption

WithParam sets a session parameter for the execution.

func WithParams ¶

func WithParams(params map[string]any) SessionOption

WithParams merges the provided parameter map into the session environment, overriding existing keys while preserving any other previously defined parameters.

type SessionOptions ¶

type SessionOptions interface {
	SetParam(string, any) error
	SetParams(map[string]any) error
	SetOutputContentType(string) error
}

type Source ¶

type Source = source.Location

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
debugger
result
source

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL