json

Documentation

Overview

Package json converts JSON to CUE. To convert CUE to JSON, use encoding/json.Marshal on a cue.Value.

Index

• func Extract(path string, data []byte) (ast.Expr, error)
• func Valid(b []byte) bool
• func Validate(b []byte, v cue.Value) error
• type Decoder
  • func NewDecoder(r *cue.Runtime, path string, src io.Reader) *Decoder
  • func (d *Decoder) Extract() (ast.Expr, error)
• type Pointer
  • func PointerFromCUEPath(p cue.Path) (Pointer, error)
  • func PointerFromTokens(tokens iter.Seq[string]) Pointer
  • func (p Pointer) Tokens() iter.Seq[string]

Functions

func Extract

func Extract(path string, data []byte) (ast.Expr, error)

Extract parses JSON-encoded data to a CUE expression, using path for position information.

func Valid

func Valid(b []byte) bool

Valid reports whether data is a valid JSON encoding.

func Validate

func Validate(b []byte, v cue.Value) error

Validate validates JSON and confirms it matches the constraints specified by v.

Types

type Decoder

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

A Decoder converts JSON values to CUE.

func NewDecoder

func NewDecoder(r *cue.Runtime, path string, src io.Reader) *Decoder

NewDecoder configures a JSON decoder. The path is used to associate position information with each node. The runtime may be nil if the decoder is only used to extract to CUE ast objects.

The runtime argument is a historical remnant and unused.

func (*Decoder) Extract

func (d *Decoder) Extract() (ast.Expr, error)

Extract converts the current JSON value to a CUE ast. It returns io.EOF if the input has been exhausted.

type Pointer

type Pointer string

Pointer represents a JSON Pointer as defined by RFC 6901. It is a slash-separated list of tokens that reference a specific location within a JSON document. TODO(go1.26) alias this to encoding/json/jsontext.Pointer

func PointerFromCUEPath

func PointerFromCUEPath(p cue.Path) (Pointer, error)

PointerFromCUEPath returns a JSON Pointer equivalent to the given CUE path. It returns an error if the path contains an element that cannot be represented as a JSON Pointer.

func PointerFromTokens

func PointerFromTokens(tokens iter.Seq[string]) Pointer

PointerFromTokens returns a JSON Pointer formed from the unquoted tokens in the given sequence. Any slash (/) or tilde (~) characters will be escaped appropriately.

func (Pointer) Tokens

func (p Pointer) Tokens() iter.Seq[string]

Tokens returns a sequence of all the unquoted path elements (tokens) of the JSON Pointer.