brewformulary

Documentation

Index

• type PreloadedFormulary
• type V1Cache
  • func FetchV1(ctx context.Context, apiclient *brewapi.Client, dir string, ...) (*V1Cache, error)
  • func LoadV1(dir string) (*V1Cache, error)
  • func (index *V1Cache) Aliases() map[string]string
  • func (index *V1Cache) FetchFormula(_ context.Context, name string) (formula.MultiPlatformFormula, error)
  • func (index *V1Cache) Find(name string) *brewv1.Info
  • func (index *V1Cache) List() brewv1.Index
  • func (index *V1Cache) ListNames() []string
  • func (index *V1Cache) SearchFunc(match func(*brewv1.Info) bool) []*brewv1.Info

Types

type PreloadedFormulary

type PreloadedFormulary interface {
	formula.Formulary
	ListNames() []string
}

PreloadedFormulary defines the formulary's capabilities.

type V1Cache

type V1Cache struct {
	// contains filtered or unexported fields
}

V1Cache represents formula data cached from the Homebrew API.

func FetchV1

func FetchV1(ctx context.Context, apiclient *brewapi.Client, dir string, autoUpdate *brewenv.AutoUpdateConfig) (*V1Cache, error)

FetchV1 fetches the v1 index either from the cache or from the API according to its existence and the auto-update configuration.

func LoadV1

func LoadV1(dir string) (*V1Cache, error)

LoadV1 loads the v1 index from a cache directory.

func (*V1Cache) Aliases

func (index *V1Cache) Aliases() map[string]string

Aliases returns the map of aliases.

func (*V1Cache) FetchFormula

func (index *V1Cache) FetchFormula(_ context.Context, name string) (formula.MultiPlatformFormula, error)

FetchFormula implements formula.Formulary.

func (*V1Cache) Find

func (index *V1Cache) Find(name string) *brewv1.Info

Find finds a formula.

func (*V1Cache) List

func (index *V1Cache) List() brewv1.Index

List produces the contents of the index.

func (*V1Cache) ListNames

func (index *V1Cache) ListNames() []string

ListNames produces the names in the index.

func (*V1Cache) SearchFunc

func (index *V1Cache) SearchFunc(match func(*brewv1.Info) bool) []*brewv1.Info

SearchFunc searches the index and returns all formulae hits from the match function.