search

package

v0.0.0-...-df3f4e6 Latest Latest Go to latest Published: Aug 8, 2023 License: BSD-3-Clause Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package search provides tools to query varda resources.

This section is empty.

This section is empty.

This section is empty.

type Query struct {
	// Expr specifies the query selection.
	Expr string

	// Sort specifies how the results should be sorted
	Sort SortKind
}

type Queryer interface {
	Query(ctx context.Context, query Query) (*Result, error)
}

type Result struct {
	Refs []varda.Ref
}

type Searcher interface {
	Search(ctx context.Context, query Query, f func(ref varda.Ref) error) error
}

type SortKind uint8

SortKind describes how the results of a query should be sorted.

const (
	UnspecifiedSort SortKind = iota
	Unsorted
	ByTimeDesc
	ByTimeAsc
	ByRefDesc
	ByRefAsc
)

func (sk SortKind) String() string