harn-stdlib 0.8.28

Embedded Harn standard library source catalog
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

/**
 * std/json/stream - incremental JSON stream validation
 *
 * Import with: import { stream_validator } from "std/json"
 */
pub enum JsonStreamStatus {
  Pending
  Valid
  Invalid(error)
}

type JsonStreamValidator = {
  feed: fn(any) -> JsonStreamStatus,
  value: fn() -> any,
  status: fn() -> JsonStreamStatus,
}

/**
 * Create an incremental validator for UTF-8 JSON string or bytes chunks.
 * `feed(chunk)` returns JsonStreamStatus.Pending, JsonStreamStatus.Valid, or
 * JsonStreamStatus.Invalid({reason, path}). `value()` returns the parsed JSON
 * value after Valid and nil otherwise.
 *
 * @effects: []
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: stream_validator(schema)
 */
pub fn stream_validator(schema) -> JsonStreamValidator {
  let handle = __json_stream_validator(schema)
  return {
    _namespace: "json_stream_validator",
    feed: fn(chunk) { return __json_stream_validator_feed(handle, chunk) },
    value: fn() { return __json_stream_validator_value(handle) },
    status: fn() { return __json_stream_validator_status(handle) },
  }
}

/**
 * `std/json/stream_validate` — standalone partial-JSON validation API.
 *
 * Verdict shape (plain dict, stable for agents to dispatch on):
 *   {verdict: "pending"}
 *   {verdict: "valid"}
 *   {verdict: "invalid", reason: <string>, path: <jsonpointer-ish>}
 *
 * `stream_validate_create(schema)` returns an opaque validator handle.
 * `stream_validate_chunk(handle, chunk)` returns the verdict after
 * consuming `chunk` (string or bytes). Once a validator reaches
 * `"invalid"` further chunks are ignored and the same verdict is
 * surfaced. `stream_validate_finalize(handle)` flushes the stream — a
 * still-pending validator with a partial document transitions to
 * `"invalid"` with `reason: "incomplete JSON document at end of stream"`.
 * The trio is also exposed as the `stream_validate` namespace record so
 * callers can write `stream_validate.create(schema)`.
 */
/**
 * Create a `stream_validate` handle for a JSON schema.
 *
 * @effects: []
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: stream_validate_create(schema)
 */
pub fn stream_validate_create(schema) -> string {
  return __json_stream_validate_create(schema)
}

/**
 * Feed the next chunk into a `stream_validate` handle. Returns the new
 * verdict dict.
 *
 * @effects: []
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: stream_validate_chunk(handle, chunk)
 */
pub fn stream_validate_chunk(handle: string, chunk) -> dict {
  return __json_stream_validate_chunk(handle, chunk)
}

/**
 * Flush a `stream_validate` handle. If the stream is still pending with
 * a partial document the verdict transitions to invalid; an already
 * valid or invalid verdict is returned unchanged.
 *
 * @effects: []
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: stream_validate_finalize(handle)
 */
pub fn stream_validate_finalize(handle: string) -> dict {
  return __json_stream_validate_finalize(handle)
}

/**
 * Namespace accessor for the `stream_validate.*` API. Returns a record
 * holding the create/chunk/finalize closures so scripts can write
 * `let sv = stream_validate(); let v = sv.create(schema)` or destructure
 * via `let {create, chunk, finalize} = stream_validate()`.
 *
 * @effects: []
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: stream_validate()
 */
pub fn stream_validate() -> dict {
  return {
    create: fn(schema) { return __json_stream_validate_create(schema) },
    chunk: fn(handle, chunk) { return __json_stream_validate_chunk(handle, chunk) },
    finalize: fn(handle) { return __json_stream_validate_finalize(handle) },
  }
}