store

package

v0.0.0 Latest Latest Go to latest Published: Jul 10, 2026 License: Apache-2.0, MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/fil-forge/hilt

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Collect[T any](ctx context.Context, getPage GetPageFunc[T]) ([]T, error)
type GetPageFunc
type Page
type PaginationConfig
type PaginationOption
- func WithCursor(cursor string) PaginationOption
- func WithLimit(limit int) PaginationOption

Constants ¶

View Source

const (
	// RecordExistsErrorName is the name given to an error where the record
	// already exists in the store.
	RecordExistsErrorName = "RecordExists"
	// RecordNotFoundErrorName is the name given to an error where the record
	// is not found in the store.
	RecordNotFoundErrorName = "RecordNotFound"
	// InvalidArgumentErrorName is the name given to an error where an argument
	// passed to a store operation is invalid.
	InvalidArgumentErrorName = "InvalidArgument"
)

Variables ¶

View Source

var (
	// ErrRecordExists is returned when a record already exists in the store.
	ErrRecordExists = errors.New(RecordExistsErrorName, "record already exists")
	// ErrRecordNotFound is returned when a record is not found in the store.
	ErrRecordNotFound = errors.New(RecordNotFoundErrorName, "record not found")
	// ErrInvalidArgument is returned when an argument passed to a store
	// operation is invalid.
	ErrInvalidArgument = errors.New(InvalidArgumentErrorName, "invalid argument")
)

Functions ¶

func Collect ¶

func Collect[T any](ctx context.Context, getPage GetPageFunc[T]) ([]T, error)

Types ¶

type GetPageFunc ¶

type GetPageFunc[T any] func(ctx context.Context, options PaginationConfig) (Page[T], error)

type Page ¶

type Page[T any] struct {
	Cursor  *string
	Results []T
}

Page is a generic type representing a paginated response from the store.

type PaginationConfig ¶

type PaginationConfig struct {
	// Cursor is an optional string that indicates where to start the page. This
	// is typically the ID of the last item from the previous page.
	Cursor *string
	// Limit is an optional integer that specifies the maximum number of items to
	// return in the page. If not provided, a default limit may be applied by the
	// implementation.
	Limit *int
}

type PaginationOption ¶

type PaginationOption func(cfg *PaginationConfig)

func WithCursor ¶

func WithCursor(cursor string) PaginationOption

func WithLimit ¶

func WithLimit(limit int) PaginationOption

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
accesskey
memory
postgres Package postgres provides a PostgreSQL-backed implementation of accesskey.Store.	Package postgres provides a PostgreSQL-backed implementation of accesskey.Store.
bucket
memory
postgres Package postgres provides a PostgreSQL-backed implementation of bucket.Store.	Package postgres provides a PostgreSQL-backed implementation of bucket.Store.
delegation
memory
postgres Package postgres provides a PostgreSQL-backed implementation of delegation.Store.	Package postgres provides a PostgreSQL-backed implementation of delegation.Store.
provider
memory
postgres Package postgres provides a PostgreSQL-backed implementation of provider.Store.	Package postgres provides a PostgreSQL-backed implementation of provider.Store.
tenant
memory
postgres Package postgres provides a PostgreSQL-backed implementation of tenant.Store.	Package postgres provides a PostgreSQL-backed implementation of tenant.Store.

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