encoding/json

CUE v0.18.0

Functions

Compact

Compact: func(src: bytes | string) -> string

Compact generates the JSON-encoded src with insignificant space characters elided.

HTMLEscape

HTMLEscape: func(src: bytes | string) -> string

HTMLEscape returns the JSON-encoded src with <, >, &, U+2028 and U+2029 characters inside string literals changed to \u003c, \u003e, \u0026, \u2028, \u2029 so that the JSON will be safe to embed inside HTML <script> tags. For historical reasons, web browsers don't honor standard HTML escaping within <script> tags, so an alternative JSON encoding must be used.

Indent

Indent: func(src: bytes | string, prefix: string, indent: string) -> string

Indent creates an indented form of the JSON-encoded src. Each element in a JSON object or array begins on a new, indented line beginning with prefix followed by one or more copies of indent according to the indentation nesting. The data appended to dst does not begin with the prefix nor any indentation, to make it easier to embed inside other formatted JSON data. Although leading space characters (space, tab, carriage return, newline) at the beginning of src are dropped, trailing space characters at the end of src are preserved and copied to dst. For example, if src has no trailing spaces, neither will dst; if src ends in a trailing newline, so will dst.

Marshal

Marshal: func(v: _) -> string

Marshal returns the JSON encoding of v.

MarshalStream

MarshalStream: func(v: _) -> string

MarshalStream turns a list into a stream of JSON objects.

Unmarshal

Unmarshal: func(b: bytes | string) -> _

Unmarshal parses the JSON-encoded data.

UnmarshalStream

UnmarshalStream: func(data: bytes | string) -> _

UnmarshalStream parses the JSON to a CUE instance.

Valid validator

validator form

validator(bytes | string)

call form

func(data: bytes | string) -> bool

Valid reports whether data is a valid JSON encoding.

Validate validator

validator form

func(v: _ @schema()) -> validator(bytes | string)

call form

func(b: bytes | string, v: _ @schema()) -> bool

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