index

type ByPrefix string

type Collection interface {
	Group

	// Keys returns a slice of Keys which give an ordering for Groups in the Collection.
	Keys() []Key

	// Get returns the Group corresponding to the given Key.
	Get(Key) Group
}

type Collector interface {
	Collect(Tracker) Collection
}

type Expander interface {
	// Expand the given string into a list of alternatives.
	Expand(string) []string
}

type Filter interface {
	// Items returns a list of FilterItems.
	Items() []FilterItem
}

type FilterItem interface {
	Name() string
	Fields() map[string]interface{}
	Paths() []Path
}

type FilterItemSlice []FilterItem

type FlatSearcher struct {
	Searcher
}

type Group interface {
	Tracker

	// Name returns the name of the group.
	Name() string

	// Field returns the value of a field.
	Field(string) interface{}
}

type Key string

type LessFn func(s, t Track) bool

type Library interface {
	// Tracks returns a slice of all the tracks in the library.
	Tracks() []Track

	// Track returns the track from the given identifier and true if successful,
	// false otherwise.
	Track(identifier string) (Track, bool)
}

type Path []Key

type PathSlice []Path

type PersistStore string

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

type Searcher interface {
	// Search uses the given string to filter a list of paths.
	Search(string) []Path
}

type Swaper interface {
	// Swap the items at indices i and j.
	Swap(i, j int)
}

type Track interface {
	// GetString returns a string value for the given attribute name.  Panics
	// if no such string attribute exists.
	GetString(string) string

	// GetStrings returns a list of strings for the given attribute name.
	// Panics if no such attribute exists.
	GetStrings(string) []string

	// GetInt returns an int value for the given attribute name.  Panics if no such
	// attribute exists.
	GetInt(string) int

	// GetTime returns a time.Time value for the given attribute name. Panics if no
	// such attribute exists.
	GetTime(string) time.Time
}

type Tracker interface {
	Tracks() []Track
}

type TransformFn func(Group) Group

type WalkFn func(Track, Path) error

type WordIndex interface {
	Searcher

	// Words returns all the words in the index.
	Words() []string
}