search

package module

v0.0.0-...-6deb74b Latest Latest Go to latest Published: Apr 6, 2024 License: Apache-2.0 Imports: 9 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

Repository

github.com/koud-fi/pkg

Links

Open Source Insights

Documentation ¶

Index ¶

type Autocompleter
- func NewAutocompleter[T Entry](idx TagIndex[T]) *Autocompleter[T]
- func (a Autocompleter[_]) Autocomplete(tags []string, limit int) ([][]TagInfo, error)
type Entry
type OrderedEntry
type QueryResult
- func (qr QueryResult[T]) Page(cursor string, limit int) ([]T, string)
- func (qr *QueryResult[_]) Reset()
type ShardedTagIndex
- func NewShardedTagIndex[T Entry](numShards int32, shardInitFn func(n int32) TagIndex[T]) ShardedTagIndex[T]
type TagIndex
- func NewMemoryTagIndex[T Entry]() TagIndex[T]
type TagInfo

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Autocompleter ¶

type Autocompleter[T Entry] struct {
	// contains filtered or unexported fields
}

func NewAutocompleter ¶

func NewAutocompleter[T Entry](idx TagIndex[T]) *Autocompleter[T]

func (Autocompleter[_]) Autocomplete ¶

func (a Autocompleter[_]) Autocomplete(tags []string, limit int) ([][]TagInfo, error)

type Entry ¶

type Entry interface {
	ID() string
	Tags() []string
}

type OrderedEntry ¶

type OrderedEntry interface {
	Entry
	Order() int64
}

type QueryResult ¶

type QueryResult[T any] struct {
	Data       []T
	TotalCount int
}

func (QueryResult[T]) Page ¶

func (qr QueryResult[T]) Page(cursor string, limit int) ([]T, string)

func (*QueryResult[_]) Reset ¶

func (qr *QueryResult[_]) Reset()

type ShardedTagIndex ¶

type ShardedTagIndex[T Entry] struct {
	// contains filtered or unexported fields
}

func NewShardedTagIndex ¶

func NewShardedTagIndex[T Entry](
	numShards int32, shardInitFn func(n int32) TagIndex[T],
) ShardedTagIndex[T]

func (ShardedTagIndex[_]) Commit ¶

func (sti ShardedTagIndex[_]) Commit() error

Commit does nothing at the moment, sub-index commit is called lazily when querying

func (ShardedTagIndex[T]) Get ¶

func (sti ShardedTagIndex[T]) Get(id ...string) ([]T, error)

func (ShardedTagIndex[T]) Put ¶

func (sti ShardedTagIndex[T]) Put(e ...T)

func (ShardedTagIndex[T]) Query ¶

func (sti ShardedTagIndex[T]) Query(dst *QueryResult[T], tags []string, limit int) error

func (ShardedTagIndex[_]) Tags ¶

func (sti ShardedTagIndex[_]) Tags(prefix string) ([]TagInfo, error)

func (ShardedTagIndex[T]) WithSeed ¶

func (sti ShardedTagIndex[T]) WithSeed(seed int64) ShardedTagIndex[T]

type TagIndex ¶

type TagIndex[T Entry] interface {
	Get(id ...string) ([]T, error)
	Query(dst *QueryResult[T], tags []string, limit int) error
	Put(e ...T)
	Commit() error
	Tags(prefix string) ([]TagInfo, error)
}

func NewMemoryTagIndex ¶

func NewMemoryTagIndex[T Entry]() TagIndex[T]

type TagInfo ¶

type TagInfo struct {
	Tag   string
	Count int
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL