resource

Documentation

Overview

Package resource supplies a generic Access[K, V] interface for CRUD operations on key-value pairs, backed by an in-memory and JSON file implementation.

Index

• Constants
• func NewInMemoryAccess[K comparable, V any]() *inMemoryAccess[K, V]
• func NewJsonFileAccess[K comparable, V any](path string) *jsonFileAccess[K, V]
• func NewMockAccess[K, V any]() *mockAccess[K, V]
• func NewSqliteAccess[K comparable, V any](db *sql.DB) *sqliteAccess[K, V]
• func NewYamlFileAccess[K comparable, V any](path string) *yamlFileAccess[K, V]
• type Access

Constants

const (
	ErrorResourceAlreadyExists = "resource already exists"
	ErrorResourceNotFound      = "resource not found"
)

Functions

func NewInMemoryAccess

func NewInMemoryAccess[K comparable, V any]() *inMemoryAccess[K, V]

NewInMemoryAccess creates a new in-memory access.

func NewJsonFileAccess

func NewJsonFileAccess[K comparable, V any](path string) *jsonFileAccess[K, V]

NewJsonFileAccess creates a new json file access.

func NewMockAccess

func NewMockAccess[K, V any]() *mockAccess[K, V]

NewMockAccess creates a new instance of MockAccess[K, V].

func NewSqliteAccess

func NewSqliteAccess[K comparable, V any](db *sql.DB) *sqliteAccess[K, V]

NewSqliteAccess creates a new instance of sqliteAccess.

func NewYamlFileAccess

func NewYamlFileAccess[K comparable, V any](path string) *yamlFileAccess[K, V]

NewYamlFileAccess creates a new yaml file access.

Types

type Access

type Access[K, V any] interface {
	Create(ctx context.Context, key K, value V) error
	Read(ctx context.Context, key K) (*V, error)
	ReadAll(ctx context.Context) ([]V, error)
	Update(ctx context.Context, key K, value V) error
	Delete(ctx context.Context, key K) error
}

Access specifies the CRUD operations for a resource using generics. It supports context.Context for cancellation and timeouts.