hal

package module

Go to main page

Versions in this module

v1

v1.4.0

Oct 30, 2026

Changes in this version

+ var ErrInvalidProfile = errors.New("hal: invalid profile")

v1.3.0

Oct 30, 2026

Changes in this version

+ const MediaTypeHAL

+ const MediaTypeVendorHAL

+ var ErrDuplicateJSONKey = errors.New("hal: duplicate JSON key")

+ var ErrEmbeddedDepthExceeded = errors.New("hal: embedded resource depth exceeded")

+ var ErrInvalidEmbedded = errors.New("hal: invalid embedded resource")

+ var ErrInvalidLink = errors.New("hal: invalid link")

+ var ErrInvalidRelation = errors.New("hal: invalid link relation")

+ var ErrLinkShape = errors.New("hal: incompatible link shape")

+ func ContentType(profiles ...string) (string, error)

+ func ValidateLink(l Link) error

+ type DuplicateKeyError struct

+ Key string

+ Offset int64

+ func (e *DuplicateKeyError) Error() string

+ func (e *DuplicateKeyError) Unwrap() error

type Envelope

+ func (e *Envelope) AddCachedLink(link Link, resource any)

+ func (e *Envelope) AddEmbedded(rel string, value any)

type InstanceOption

+ func WithLinkShape(shape LinkShape) InstanceOption

+ func WithRelationShape(rel string, shape LinkShape) InstanceOption

+ func WithStrictCuries() InstanceOption

+ func WithStrictJSON() InstanceOption

+ func WithStrictLinks() InstanceOption

+ func WithStrictRelations() InstanceOption

+ type LinkShape uint8

+ const ShapeArray

+ const ShapeAuto

+ const ShapeObject

+ func (s LinkShape) String() string

type PrecomputedLinks

+ func CompilePrecomputedLinksStrict(linksJSON []byte) (*PrecomputedLinks, error)

v1.2.0

Oct 30, 2026

v1.1.0

Oct 29, 2026

Changes in this version

+ var ErrAddLinkPrecomputed = errors.New("hal: cannot add links to a static or precomputed envelope")

+ var ErrDuplicateCurie = errors.New("hal: duplicate CURIE declaration")

+ var ErrHALFieldConflict = errors.New("hal: data already contains reserved HAL field")

+ var ErrInvalidCurie = errors.New("hal: invalid CURIE declaration")

type Instance

+ func (i *Instance) WrapPrecomputedLinks(data any, links *PrecomputedLinks) *Envelope

type PrecomputedLinks

+ func CompilePrecomputedLinks(linksJSON []byte) (*PrecomputedLinks, error)

v1.0.0

Apr 22, 2026

Changes in this version

+ var DefaultInstance = New()

+ func GetVersion() string

+ func RegisterCurie(prefix, href string)

+ func RegisterInstance[T any](i *Instance, gen func(context.Context, *T) []Link)

+ func RegisterStatic(i *Instance, target any, links []Link)

+ func Register[T any](gen func(context.Context, *T) []Link)

+ type CollectionPage struct

+ Count int

+ Embedded map[string]any

+ Links map[string]any

+ Total int

+ func Collection[T any](ctx context.Context, items []*T, total int, selfLink Link) *CollectionPage

+ type Envelope struct

+ Data any

+ func Wrap(ctx context.Context, data any) *Envelope

+ func (e *Envelope) AddLink(l Link)

+ func (e *Envelope) MarshalJSON() ([]byte, error)

+ type Generator func(ctx context.Context, v any) []Link

+ type Instance struct

+ func New(opts ...InstanceOption) *Instance

+ func (i *Instance) Collection(ctx context.Context, items any, total int, selfLink Link) *CollectionPage

+ func (i *Instance) RegisterCurie(prefix, href string)

+ func (i *Instance) RegisterInstance(gen any)

+ func (i *Instance) RegisteredTypes() []reflect.Type

+ func (i *Instance) Wrap(ctx context.Context, data any) *Envelope

+ func (i *Instance) WrapPrecomputed(_ context.Context, data any, linksJSON []byte) *Envelope

+ func (i *Instance) WrapRaw(data any) *Envelope

+ type InstanceOption func(*Instance)

+ func WithStrictMode() InstanceOption

+ type Link struct

+ Deprecation string

+ Href string

+ HrefLang string

+ Method string

+ Name string

+ Profile string

+ Rel string

+ Templated bool

+ Title string

+ Type string

+ type PrecomputedLinks struct

+ JSON []byte

+ type VersionInfo struct

+ Major int

+ Minor int

+ Patch int

+ PreRelease string

+ func GetVersionInfo() VersionInfo

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL