Documentation
¶
Overview ¶
Package hjson provides HJSON encoding helpers and adapters used by go-service.
This package integrates HJSON encoding/decoding behind the go-service encoding abstraction. Decode rejects duplicate object keys and unknown destination fields.
Start with the package-level constructors.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Encoder ¶
type Encoder struct{}
Encoder implements HJSON encoding and decoding.
func NewEncoder ¶
func NewEncoder() *Encoder
NewEncoder constructs an HJSON encoder.
This encoder is a thin adapter around github.com/hjson/hjson-go that satisfies github.com/alexfalkowski/go-service/v2/encoding.Encoder.
func (*Encoder) Decode ¶
Decode reads HJSON from r and decodes it into v.
In most cases v should be a pointer to the destination value (for example *MyStruct). Decode rejects duplicate object keys and unknown destination fields. Decode buffers all remaining input from r before decoding; callers should bound untrusted or potentially large readers before calling it.
Source Files