search

Documentation

Overview

TODO:

> Write unit tests
> Document symbols
> Convert type of Request.Suggestions:
	> uint -> uint8
		255 suggestions is enough
> Add additional commands to manage environment variables
	> set
	> unset
	> export
	> import
> Rename KeyParallel -> CtxParallel

Index

• Constants
• type Engine
  • func New(ctx context.Context, targets map[string]*interface{}) Engine
• type Request
• type Response

Constants

const KeyParallel contextKey = "parallel"

Types

type Engine

type Engine interface {
	Query(query string, suggestions uint) Engine
	QueryAll(queries []string, suggestions uint) Engine
	Result() *Response
	Results() []*Response
}

func New

func New(ctx context.Context, targets map[string]*interface{}) Engine

type Request

type Request struct {
	Query       string
	Suggestions uint
}

type Response

type Response struct {
	Match       *interface{}
	Suggestions []string
	Request     *Request
}