search

Documentation

Overview

Package search provides search interface and functionality

Index

• Variables
• func DoRequest(ctx context.Context, req *http.Request, f func(*http.Response, error) error) error
• func ParseGoto(g string) int
• func ParsePage(p string) int
• func ParseTimeout(t string) time.Duration
• func PrintResults(query Query, err error)
• func Register(name string, provider interface{}) error
• func Searchers() []string
• type Query
  • func Do(ctx context.Context, query Query) (Query, error)
• type Result
• type Results
  • func (r Results) Len() int
  • func (r Results) Less(i, j int) bool
  • func (r Results) Swap(i, j int)
• type Searcher

Variables

var (
	// Logger is the logger
	Logger *log.Logger
)

Functions

func DoRequest

func DoRequest(ctx context.Context, req *http.Request, f func(*http.Response, error) error) error

DoRequest makes a HTTP request with context

func ParseGoto

func ParseGoto(g string) int

ParseGoto parses goto from a given string

func ParsePage

func ParsePage(p string) int

ParsePage parses page from a given string

func ParseTimeout

func ParseTimeout(t string) time.Duration

ParseTimeout parses timeout from a given string

func PrintResults

func PrintResults(query Query, err error)

PrintResults prints the given search results

func Register

func Register(name string, provider interface{}) error

Register registers a search provider

func Searchers

func Searchers() []string

Searchers returns a sorted list of the names of the registered searchers

Types

type Query

type Query struct {
	Provider string
	Keyword  string
	Page     int
	Goto     int
	Timeout  time.Duration
	Start    time.Time
	Elapsed  time.Duration
	Results  Results
}

Query represents a search query

func Do

func Do(ctx context.Context, query Query) (Query, error)

Do makes a query by the given context and query

type Result

type Result struct {
	Description string
	Link        string
}

Result represents a search result

type Results

type Results []Result

Results represents a list of search results

func (Results) Len

func (r Results) Len() int

Sort implementation

func (Results) Less

func (r Results) Less(i, j int) bool

func (Results) Swap

func (r Results) Swap(i, j int)

type Searcher

type Searcher interface {
	// Search makes a search
	Search(ctx context.Context, args map[string]interface{}) ([]map[string]interface{}, error)
}

Searcher is the interface that must be implemented by a search provider