search

Documentation

Overview

Package search provides search engines using a common interface.

Index

• type Google
  • func (s *Google) Search(ctx context.Context, query string) <-chan Result
• type Result
• type Searcher

Types

type Google

type Google struct {
	APIKey string // api key enabled for the custom search api
	CX     string // custom search engine id. If empty a default is used.
}

Google implements Searcher for Google custom search engines.

func (*Google) Search

func (s *Google) Search(ctx context.Context, query string) <-chan Result

Search implements Searcher for google. At most 100 results can be returned (limit by Google).

type Result

type Result struct {
	URL string // url of the search result.
}

Result represents a search result.

type Searcher

type Searcher interface {
	// Search searches for results using the query.
	// It returns a channel which sends the results.
	// To stop searching, cancel the context.
	Search(ctx context.Context, query string) <-chan Result
}

Searcher provides an interface for query-based searching.