neco_gleam/json

Types

Failure

pub type Failure {
  Invalid(offset: Int, message: String)
  InvalidUtf8(offset: Int)
  UnexpectedEnd(offset: Int)
  Trailing(offset: Int)
  DuplicateKey(offset: Int, key: String)
  EncodeDuplicateKey(key: String)
}

Constructors

```
Invalid(offset: Int, message: String)
```
```
InvalidUtf8(offset: Int)
```
```
UnexpectedEnd(offset: Int)
```
```
Trailing(offset: Int)
```
```
DuplicateKey(offset: Int, key: String)
```
```
EncodeDuplicateKey(key: String)
```

Number

opaque </>

A value that preserves a validated JSON number token.

pub opaque type Number

Value

</>

pub type Value {
  Null
  Bool(value: Bool)
  Number(value: Number)
  String(value: String)
  Array(values: List(Value))
  Object(fields: List(#(String, Value)))
}

Constructors

```
Null
```
```
Bool(value: Bool)
```
```
Number(value: Number)
```
```
String(value: String)
```
```
Array(values: List(Value))
```
```
Object(fields: List(#(String, Value)))
```

Values

canonicalize

</>

pub fn canonicalize(value: Value) -> Value

Recursively orders object fields by Unicode scalar value while preserving array order, number tokens, and duplicate fields.

decode

</>

pub fn decode(bytes: BitArray) -> Result(Value, Failure)

Decodes one JSON value from UTF-8 bytes. JSON whitespace may surround the value, while trailing non-whitespace bytes produce Trailing. Other typed failures cover invalid UTF-8, invalid JSON, duplicate keys, and nesting at the parser limit.

encode

</>

pub fn encode(value: Value) -> Result(BitArray, Failure)

Encodes the UTF-8 bytes of encode_text with the same failure values.

encode_text

</>

pub fn encode_text(value: Value) -> Result(String, Failure)

Encodes deterministic JSON text after ordering object fields. Duplicate object keys produce EncodeDuplicateKey.

number_from_int

</>

pub fn number_from_int(value: Int) -> Number

Uses the decimal integer spelling as a JSON number token.

number_from_string

</>

pub fn number_from_string(text: String) -> Result(Number, Nil)

Preserves text when it follows the JSON number grammar, with Error(Nil) for other strings.