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 NewMockAccess[K, V any]() *mockAccess[K, V]
• type Access
  • func NewJsonFileAccess[K comparable, V any](path string) Access[K, V]
• type JsonFileAccess
  • func (a *JsonFileAccess[K, V]) Create(key K, value V) error
  • func (a *JsonFileAccess[K, V]) Delete(key K) error
  • func (a *JsonFileAccess[K, V]) Read(key K) (*V, error)
  • func (a *JsonFileAccess[K, V]) ReadAll() ([]V, error)
  • func (a *JsonFileAccess[K, V]) Update(key K, value V) error

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 NewMockAccess

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

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

Types

type Access

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

Access specifies the CRUD operations for a resource using generics.

func NewJsonFileAccess

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

NewJsonFileAccess creates a new json file access.

type JsonFileAccess

type JsonFileAccess[K comparable, V any] struct {
	// contains filtered or unexported fields
}

JsonFileAccess is a json file access.

func (*JsonFileAccess[K, V]) Create

func (a *JsonFileAccess[K, V]) Create(key K, value V) error

Create creates a new resource.

func (*JsonFileAccess[K, V]) Delete

func (a *JsonFileAccess[K, V]) Delete(key K) error

Delete deletes a resource.

func (*JsonFileAccess[K, V]) Read

func (a *JsonFileAccess[K, V]) Read(key K) (*V, error)

Read reads a resource.

func (*JsonFileAccess[K, V]) ReadAll

func (a *JsonFileAccess[K, V]) ReadAll() ([]V, error)

ReadAll reads all resources.

func (*JsonFileAccess[K, V]) Update

func (a *JsonFileAccess[K, V]) Update(key K, value V) error

Update updates a resource.