api

type Location ¶

type Location = source.Location

Location represents the location of a specific point in a source file, including the file name and position.

type OptimizationLevel ¶

type OptimizationLevel int

const (
	OptimizationNone OptimizationLevel = iota
	OptimizationBasic
	OptimizationFull
	OptimizationAggressive
)

type Output ¶

type Output = encoding.Output

Output is the encoded result returned from session or engine execution.

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(level OptimizationLevel) PlanOption

type PlanOptions ¶

type PlanOptions interface {
	SetOptimizationLevel(OptimizationLevel) error
}

type Position ¶

type Position = source.Position

Position represents a specific point in a source file, defined by line and column numbers.

type Range ¶

type Range = source.Range

Range represents a range of characters in a source file, including the location and span.

type Runtime ¶

type Runtime interface {
	io.Closer
	Run(ctx context.Context, src Source, opts ...SessionOption) (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) (Output, error)
}

type SessionOption ¶

type SessionOption = func(SessionOptions) error

func WithOutputContentType(contentType string) SessionOption

func WithParam(key string, value any) SessionOption

func WithParams(params map[string]any) SessionOption

type SessionOptions ¶

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

type Source ¶

type Source = source.Source

Source represents the input data for a Ferret query.

func NewAnonymousSource(content string) Source

func NewSource(name, content string) Source

type Span ¶

type Span = source.Span

Span represents a range of characters in a source file, defined by start and end positions.