providers

Documentation

Index

• Variables
• func AddProvider(name string, provider Provider)
• func DisplayProviders() string
• func ExpandProvider(provider string) (string, error)
• func Language() string
• func ProviderNames() []string
• func Region() string
• func Search(binary string, p string, q string, verbose bool) error
• func SetBlacklist(b []string)
• func SetWhitelist(w []string)
• type CustomProvider
  • func (c *CustomProvider) BuildURI(q string) string
  • func (c *CustomProvider) Valid() error
• type Provider

Variables

var Providers map[string]Provider

Providers tracks loaded providers.

Functions

func AddProvider

func AddProvider(name string, provider Provider)

AddProvider should be called within your provider's init() func. This will register the provider so it can be used.

func DisplayProviders

func DisplayProviders() string

DisplayProviders displays all the loaded providers.

func ExpandProvider

func ExpandProvider(provider string) (string, error)

ExpandProvider expands the passed in provider to the full value.

func Language

func Language() string

Language returns the users language code. Eg. "en", "es", etc

func ProviderNames

func ProviderNames() []string

ProviderNames returns a sorted slice of provider names.

func Region

func Region() string

Region returns the users region code. Eg. "US", "GB", etc

func Search

func Search(binary string, p string, q string, verbose bool) error

Search builds a search URL and opens it in your browser.

func SetBlacklist

func SetBlacklist(b []string)

SetBlacklist filters out unneeded providers.

func SetWhitelist

func SetWhitelist(w []string)

SetWhitelist sets an exact list of supported providers.

Types

type CustomProvider

type CustomProvider struct {
	Name string `json:"name"`
	Url  string `json:"url"`
}

CustomProvider is used for Config based providers.

func (*CustomProvider) BuildURI

func (c *CustomProvider) BuildURI(q string) string

BuildURI builds the URI for custom providers.

func (*CustomProvider) Valid

func (c *CustomProvider) Valid() error

Valid checks if the custom provider is setup correctly.

type Provider

type Provider interface {
	BuildURI(string) string
}

Provider interface provides a way to build the URI for each provider.