search

Documentation

Overview

Package search provides search interface and functionality

Index

• func Init(c conf.Config)
• func ParseGoto(gt string) int
• func ParseLimit(limit string) int
• func ParsePage(page string) int
• func ParseTimeout(timeout string) time.Duration
• func ProviderRegister(provider interface{}) error
• func Providers() []string
• type Provider
  • func ProviderByName(name string) (Provider, error)
• type Query
  • func (query *Query) Do() error
  • func (query *Query) DoPrint(err 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

Functions

func Init

func Init(c conf.Config)

Init initializes the search

func ParseGoto

func ParseGoto(gt string) int

ParseGoto parses goto from a given string

func ParseLimit

func ParseLimit(limit string) int

ParseLimit parses limit from a given string

func ParsePage

func ParsePage(page string) int

ParsePage parses page from a given string

func ParseTimeout

func ParseTimeout(timeout string) time.Duration

ParseTimeout parses timeout from a given string

func ProviderRegister

func ProviderRegister(provider interface{}) error

ProviderRegister registers a search provider

func Providers

func Providers() []string

Providers returns a sorted list of the names of the providers

Types

type Provider

type Provider struct {
	Name     string
	Title    string
	Enabled  bool
	Noui     bool
	Priority int64
	Rewrite  string
	Searcher
}

Provider represents a provider

func ProviderByName

func ProviderByName(name string) (Provider, error)

ProviderByName returns a provider by the given name

type Query

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

Query represents a search query

func (*Query) Do

func (query *Query) Do() error

Do runs the search query

func (*Query) DoPrint

func (query *Query) DoPrint(err error)

DoPrint handles terminal output for Do function

type Result

type Result struct {
	Link        string    `json:"link"`
	Title       string    `json:"title"`
	Description string    `json:"description"`
	Date        time.Time `json:"date"`
	From        string    `json:"from"`
}

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