json

README

json

Table of contents

• Summary
• Architecture
• Dependencies

Summary

This package provides generic, type-safe utilities for unmarshalling raw JSON into typed Go structs, along with testing helpers for managing deterministic sequences of JSON values and a simple serialiser with capability to serialise for specific group of interest.

Architecture

Dependencies

Documentation

Index

• Variables
• func MustBuildJSON[T any](data json.RawMessage) *T
• func NewJSON[T any](data json.RawMessage) (*T, error)
• type RawMessageSequenceMap
  • func NewRawMessageSequenceMap(input map[string][]json.RawMessage) *RawMessageSequenceMap
  • func (s *RawMessageSequenceMap) Next(key string) json.RawMessage
• type Serialiser
  • func NewSerialiser() *Serialiser
  • func (s *Serialiser) Serialise(input any, groups []string) ([]byte, error)

Variables

var (
	// ErrPkg package error.
	ErrPkg = errors.New("json")
	// ErrJSON error.
	ErrJSON = fmt.Errorf("%w: JSON error", ErrPkg)
	// ErrMarshal error.
	ErrMarshal = fmt.Errorf("%w: marshal error", ErrJSON)
)

Functions

func MustBuildJSON

func MustBuildJSON[T any](data json.RawMessage) *T

MustBuildJSON factory, use it if the error is not worth handling.

func NewJSON

func NewJSON[T any](data json.RawMessage) (*T, error)

NewJSON factory.

Types

type RawMessageSequenceMap

type RawMessageSequenceMap struct {
	// contains filtered or unexported fields
}

RawMessageSequenceMap provides deterministic, per-key sequences of json.RawMessage values. It is useful for testing scenarios where each key should return a specific sequence of values on consecutive calls.

func NewRawMessageSequenceMap

func NewRawMessageSequenceMap(input map[string][]json.RawMessage) *RawMessageSequenceMap

NewRawMessageSequenceMap initialises and returns a new instance of JSONSequence.

func (*RawMessageSequenceMap) Next

func (s *RawMessageSequenceMap) Next(key string) json.RawMessage

Next returns the next json.RawMessage for the given key in the predefined sequence. If the key is unknown or has an empty sequence, it returns nil. If the sequence is exhausted, the last value is returned repeatedly.

type Serialiser

type Serialiser struct{}

Serialiser is a serialiser service.

func NewSerialiser

func NewSerialiser() *Serialiser

NewSerialiser a group specific factory.

func (*Serialiser) Serialise

func (s *Serialiser) Serialise(input any, groups []string) ([]byte, error)

Serialise a simple serialiser with capability to serialise for specific group of interest.