kv

README

go-kv

Go module to generically interact with key/value stores in the spirit of GoCloud.

install

go get github.com/frantjc/go-kv

Documentation

Index

• Variables
• func Register(opener URLOpener, scheme string, schemes ...string)
• type Codec
• type JSON
  • func (c JSON) Marshal(v any) ([]byte, error)
  • func (c JSON) Unmarshal(data []byte, v any) error
• type Store
  • func Open(ctx context.Context, s string) (Store, error)
• type URLOpener

Variables

var DefaultCodec = JSON{}

Functions

func Register

func Register(opener URLOpener, scheme string, schemes ...string)

Types

type Codec

type Codec interface {
	// Marshal encodes a Go value to a slice of bytes.
	Marshal(v any) ([]byte, error)
	// Unmarshal decodes a slice of bytes into a Go value.
	Unmarshal(data []byte, v any) error
}

type JSON

type JSON struct{}

JSON encodes/decodes Go values to/from JSON.

func (JSON) Marshal

func (c JSON) Marshal(v any) ([]byte, error)

Marshal encodes a Go value to JSON.

func (JSON) Unmarshal

func (c JSON) Unmarshal(data []byte, v any) error

Unmarshal decodes a JSON value into a Go value.

type Store

type Store interface {
	Set(context.Context, string, any) error
	Get(context.Context, string, any) (bool, error)
	Delete(context.Context, string) error
	Close() error
}

func Open

func Open(ctx context.Context, s string) (Store, error)

type URLOpener

type URLOpener interface {
	Open(context.Context, *url.URL) (Store, error)
}