providers

Documentation

Index

• Variables
• func AddProvider(name string, provider Provider)
• func DisplayProviders(verbose bool) string
• func DisplayTags(verbose bool) string
• func ExpandProvider(provider string) (string, error)
• func ExpandTag(tag string) (string, error)
• func Language() string
• func ProviderNames(verbose bool) []string
• func Region() string
• func Search(binary string, p string, t string, q string, userProvider bool, verbose bool) error
• func SetBlacklist(b []string)
• func SetClientLocale(locale string)
• func SetWhitelist(w []string)
• func TagNames(verbose bool) []string
• type CustomProvider
  • func (c *CustomProvider) BuildURI(q string) string
  • func (c *CustomProvider) Tags() []string
  • func (c *CustomProvider) Valid() error
• type Provider
  • func GetProvidersByTag(tag string) []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(verbose bool) string

DisplayProviders displays all the loaded providers.

func DisplayTags

func DisplayTags(verbose bool) string

DisplayTags displays all the available tags.

func ExpandProvider

func ExpandProvider(provider string) (string, error)

ExpandProvider expands the passed in provider to the full value.

func ExpandTag

func ExpandTag(tag string) (string, error)

ExpandTag expands the passed in tag to the full value.

func Language

func Language() string

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

func ProviderNames

func ProviderNames(verbose bool) []string

ProviderNames returns a sorted slice of provider names applying both the whitelist and then the blacklist.

func Region

func Region() string

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

func Search

func Search(binary string, p string, t string, q string, userProvider bool, 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 SetClientLocale

func SetClientLocale(locale string)

SetClientLocale sets the locale of the client connecting to the web server.

func SetWhitelist

func SetWhitelist(w []string)

SetWhitelist sets an exact list of supported providers.

func TagNames

func TagNames(verbose bool) []string

TagNames returns a deduped and sorted slice of tag names.

Types

type CustomProvider

type CustomProvider struct {
	Name    string   `json:"name"`
	URL     string   `json:"url"`
	TagList []string `json:"tags"`
}

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) Tags

func (c *CustomProvider) Tags() []string

Tags returns the tags relevant to this provider.

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
	Tags() []string
}

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

func GetProvidersByTag

func GetProvidersByTag(tag string) []Provider

GetProvidersByTag gets all providers with a specific tag.