hints

package

v0.3.8 Latest Latest Go to latest Published: Nov 11, 2026 License: GPL-3.0 Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/braedonsaunders/ether

Links

Open Source Insights

Documentation ¶

Overview ¶

Package hints marshals typed resolver hints for KindItem.Hints. Hints are opaque to Ether, stored verbatim and echoed back at resolve time; put ids and locators here, never secrets.

Index ¶

Constants
func Fields(values map[string]any) (map[string]json.RawMessage, error)
func Marshal(v any) (json.RawMessage, error)
func Unmarshal(raw json.RawMessage, v any) error

Constants ¶

View Source

const MaxBytes = 16 << 10

MaxBytes is Ether's hints cap.

Variables ¶

This section is empty.

Functions ¶

func Fields ¶

func Fields(values map[string]any) (map[string]json.RawMessage, error)

Fields encodes a value map as KindItem.Fields (key -> raw JSON value).

func Marshal ¶

func Marshal(v any) (json.RawMessage, error)

Marshal encodes a hints struct as the JSON object KindItem.Hints holds.

func Unmarshal ¶

func Unmarshal(raw json.RawMessage, v any) error

Unmarshal decodes hints into a typed struct; empty hints leave v alone.

Types ¶

This section is empty.

Source Files ¶

View all Source files

hints.go

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