flatcc 24.3.25

Build-time convenience utilities for flatbuffers
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "definitions": {
    "MyGame_OtherNameSpace_FromInclude" : {
      "type" : "string",
      "enum": ["IncludeVal"]
    },
    "MyGame_Example_Color" : {
      "type" : "string",
      "enum": ["Red", "Green", "Blue"]
    },
    "MyGame_Example_Race" : {
      "type" : "string",
      "enum": ["None", "Human", "Dwarf", "Elf"]
    },
    "MyGame_Example_LongEnum" : {
      "type" : "string",
      "enum": ["LongOne", "LongTwo", "LongBig"]
    },
    "MyGame_Example_Any" : {
      "type" : "string",
      "enum": ["NONE", "Monster", "TestSimpleTableWithEnum", "MyGame_Example2_Monster"]
    },
    "MyGame_Example_AnyUniqueAliases" : {
      "type" : "string",
      "enum": ["NONE", "M", "TS", "M2"]
    },
    "MyGame_Example_AnyAmbiguousAliases" : {
      "type" : "string",
      "enum": ["NONE", "M1", "M2", "M3"]
    },
    "MyGame_OtherNameSpace_Unused" : {
      "type" : "object",
      "properties" : {
        "a" : {
                "type" : "integer", "minimum" : -2147483648, "maximum" : 2147483647
              }
      },
      "additionalProperties" : false
    },
    "MyGame_OtherNameSpace_TableB" : {
      "type" : "object",
      "properties" : {
        "a" : {
                "$ref" : "#/definitions/TableA"
              }
      },
      "additionalProperties" : false
    },
    "TableA" : {
      "type" : "object",
      "properties" : {
        "b" : {
                "$ref" : "#/definitions/MyGame_OtherNameSpace_TableB"
              }
      },
      "additionalProperties" : false
    },
    "MyGame_InParentNamespace" : {
      "type" : "object",
      "properties" : {
      },
      "additionalProperties" : false
    },
    "MyGame_Example2_Monster" : {
      "type" : "object",
      "properties" : {
      },
      "additionalProperties" : false
    },
    "MyGame_Example_Test" : {
      "type" : "object",
      "properties" : {
        "a" : {
                "type" : "integer", "minimum" : -32768, "maximum" : 32767
              },
        "b" : {
                "type" : "integer", "minimum" : -128, "maximum" : 127
              }
      },
      "additionalProperties" : false
    },
    "MyGame_Example_TestSimpleTableWithEnum" : {
      "type" : "object",
      "properties" : {
        "color" : {
                "$ref" : "#/definitions/MyGame_Example_Color"
              }
      },
      "additionalProperties" : false
    },
    "MyGame_Example_Vec3" : {
      "type" : "object",
      "properties" : {
        "x" : {
                "type" : "number"
              },
        "y" : {
                "type" : "number"
              },
        "z" : {
                "type" : "number"
              },
        "test1" : {
                "type" : "number"
              },
        "test2" : {
                "$ref" : "#/definitions/MyGame_Example_Color"
              },
        "test3" : {
                "$ref" : "#/definitions/MyGame_Example_Test"
              }
      },
      "additionalProperties" : false
    },
    "MyGame_Example_Ability" : {
      "type" : "object",
      "properties" : {
        "id" : {
                "type" : "integer", "minimum" : 0, "maximum" : 4294967295
              },
        "distance" : {
                "type" : "integer", "minimum" : 0, "maximum" : 4294967295
              }
      },
      "additionalProperties" : false
    },
    "MyGame_Example_StructOfStructs" : {
      "type" : "object",
      "properties" : {
        "a" : {
                "$ref" : "#/definitions/MyGame_Example_Ability"
              },
        "b" : {
                "$ref" : "#/definitions/MyGame_Example_Test"
              },
        "c" : {
                "$ref" : "#/definitions/MyGame_Example_Ability"
              }
      },
      "additionalProperties" : false
    },
    "MyGame_Example_StructOfStructsOfStructs" : {
      "type" : "object",
      "properties" : {
        "a" : {
                "$ref" : "#/definitions/MyGame_Example_StructOfStructs"
              }
      },
      "additionalProperties" : false
    },
    "MyGame_Example_Stat" : {
      "type" : "object",
      "properties" : {
        "id" : {
                "type" : "string"
              },
        "val" : {
                "type" : "integer", "minimum" : -9223372036854775808, "maximum" : 9223372036854775807
              },
        "count" : {
                "type" : "integer", "minimum" : 0, "maximum" : 65535
              }
      },
      "additionalProperties" : false
    },
    "MyGame_Example_Referrable" : {
      "type" : "object",
      "properties" : {
        "id" : {
                "type" : "integer", "minimum" : 0, "maximum" : 18446744073709551615
              }
      },
      "additionalProperties" : false
    },
    "MyGame_Example_Monster" : {
      "type" : "object",
      "description" : "an example documentation comment: \"monster object\"",
      "properties" : {
        "pos" : {
                "$ref" : "#/definitions/MyGame_Example_Vec3"
              },
        "mana" : {
                "type" : "integer", "minimum" : -32768, "maximum" : 32767
              },
        "hp" : {
                "type" : "integer", "minimum" : -32768, "maximum" : 32767
              },
        "name" : {
                "type" : "string"
              },
        "friendly" : {
                "type" : "boolean",
                "deprecated" : true
              },
        "inventory" : {
                "type" : "array", "items" : {"type" : "integer", "minimum" : 0, "maximum" :255}
              },
        "color" : {
                "$ref" : "#/definitions/MyGame_Example_Color"
              },
        "test_type" : {
                "$ref" : "#/definitions/MyGame_Example_Any"
              },
        "test" : {
                "anyOf": [{ "$ref" : "#/definitions/MyGame_Example_Monster" },{ "$ref" : "#/definitions/MyGame_Example_TestSimpleTableWithEnum" },{ "$ref" : "#/definitions/MyGame_Example2_Monster" }]
              },
        "test4" : {
                "type" : "array", "items" : {"$ref" : "#/definitions/MyGame_Example_Test"}
              },
        "testarrayofstring" : {
                "type" : "array", "items" : {"type" : "string"}
              },
        "testarrayoftables" : {
                "type" : "array", "items" : {"$ref" : "#/definitions/MyGame_Example_Monster"},
                "description" : "an example documentation comment: this will end up in the generated code\nmultiline too"
              },
        "enemy" : {
                "$ref" : "#/definitions/MyGame_Example_Monster"
              },
        "testnestedflatbuffer" : {
                "type" : "array", "items" : {"type" : "integer", "minimum" : 0, "maximum" :255}
              },
        "testempty" : {
                "$ref" : "#/definitions/MyGame_Example_Stat"
              },
        "testbool" : {
                "type" : "boolean"
              },
        "testhashs32_fnv1" : {
                "type" : "integer", "minimum" : -2147483648, "maximum" : 2147483647
              },
        "testhashu32_fnv1" : {
                "type" : "integer", "minimum" : 0, "maximum" : 4294967295
              },
        "testhashs64_fnv1" : {
                "type" : "integer", "minimum" : -9223372036854775808, "maximum" : 9223372036854775807
              },
        "testhashu64_fnv1" : {
                "type" : "integer", "minimum" : 0, "maximum" : 18446744073709551615
              },
        "testhashs32_fnv1a" : {
                "type" : "integer", "minimum" : -2147483648, "maximum" : 2147483647
              },
        "testhashu32_fnv1a" : {
                "type" : "integer", "minimum" : 0, "maximum" : 4294967295
              },
        "testhashs64_fnv1a" : {
                "type" : "integer", "minimum" : -9223372036854775808, "maximum" : 9223372036854775807
              },
        "testhashu64_fnv1a" : {
                "type" : "integer", "minimum" : 0, "maximum" : 18446744073709551615
              },
        "testarrayofbools" : {
                "type" : "array", "items" : {"type" : "boolean"}
              },
        "testf" : {
                "type" : "number"
              },
        "testf2" : {
                "type" : "number"
              },
        "testf3" : {
                "type" : "number"
              },
        "testarrayofstring2" : {
                "type" : "array", "items" : {"type" : "string"}
              },
        "testarrayofsortedstruct" : {
                "type" : "array", "items" : {"$ref" : "#/definitions/MyGame_Example_Ability"}
              },
        "flex" : {
                "type" : "array", "items" : {"type" : "integer", "minimum" : 0, "maximum" :255}
              },
        "test5" : {
                "type" : "array", "items" : {"$ref" : "#/definitions/MyGame_Example_Test"}
              },
        "vector_of_longs" : {
                "type" : "array", "items" : {"type" : "integer", "minimum" : -9223372036854775808, "maximum" : 9223372036854775807}
              },
        "vector_of_doubles" : {
                "type" : "array", "items" : {"type" : "number"}
              },
        "parent_namespace_test" : {
                "$ref" : "#/definitions/MyGame_InParentNamespace"
              },
        "vector_of_referrables" : {
                "type" : "array", "items" : {"$ref" : "#/definitions/MyGame_Example_Referrable"}
              },
        "single_weak_reference" : {
                "type" : "integer", "minimum" : 0, "maximum" : 18446744073709551615
              },
        "vector_of_weak_references" : {
                "type" : "array", "items" : {"type" : "integer", "minimum" : 0, "maximum" : 18446744073709551615}
              },
        "vector_of_strong_referrables" : {
                "type" : "array", "items" : {"$ref" : "#/definitions/MyGame_Example_Referrable"}
              },
        "co_owning_reference" : {
                "type" : "integer", "minimum" : 0, "maximum" : 18446744073709551615
              },
        "vector_of_co_owning_references" : {
                "type" : "array", "items" : {"type" : "integer", "minimum" : 0, "maximum" : 18446744073709551615}
              },
        "non_owning_reference" : {
                "type" : "integer", "minimum" : 0, "maximum" : 18446744073709551615
              },
        "vector_of_non_owning_references" : {
                "type" : "array", "items" : {"type" : "integer", "minimum" : 0, "maximum" : 18446744073709551615}
              },
        "any_unique_type" : {
                "$ref" : "#/definitions/MyGame_Example_AnyUniqueAliases"
              },
        "any_unique" : {
                "anyOf": [{ "$ref" : "#/definitions/MyGame_Example_Monster" },{ "$ref" : "#/definitions/MyGame_Example_TestSimpleTableWithEnum" },{ "$ref" : "#/definitions/MyGame_Example2_Monster" }]
              },
        "any_ambiguous_type" : {
                "$ref" : "#/definitions/MyGame_Example_AnyAmbiguousAliases"
              },
        "any_ambiguous" : {
                "anyOf": [{ "$ref" : "#/definitions/MyGame_Example_Monster" },{ "$ref" : "#/definitions/MyGame_Example_Monster" },{ "$ref" : "#/definitions/MyGame_Example_Monster" }]
              },
        "vector_of_enums" : {
                "type" : "array", "items" : {"$ref" : "#/definitions/MyGame_Example_Color"}
              },
        "signed_enum" : {
                "$ref" : "#/definitions/MyGame_Example_Race"
              },
        "testrequirednestedflatbuffer" : {
                "type" : "array", "items" : {"type" : "integer", "minimum" : 0, "maximum" :255}
              },
        "scalar_key_sorted_tables" : {
                "type" : "array", "items" : {"$ref" : "#/definitions/MyGame_Example_Stat"}
              },
        "native_inline" : {
                "$ref" : "#/definitions/MyGame_Example_Test"
              },
        "long_enum_non_enum_default" : {
                "$ref" : "#/definitions/MyGame_Example_LongEnum"
              },
        "long_enum_normal_default" : {
                "$ref" : "#/definitions/MyGame_Example_LongEnum"
              },
        "nan_default" : {
                "type" : "number"
              },
        "inf_default" : {
                "type" : "number"
              },
        "positive_inf_default" : {
                "type" : "number"
              },
        "infinity_default" : {
                "type" : "number"
              },
        "positive_infinity_default" : {
                "type" : "number"
              },
        "negative_inf_default" : {
                "type" : "number"
              },
        "negative_infinity_default" : {
                "type" : "number"
              },
        "double_inf_default" : {
                "type" : "number"
              }
      },
      "required" : ["name"],
      "additionalProperties" : false
    },
    "MyGame_Example_TypeAliases" : {
      "type" : "object",
      "properties" : {
        "i8" : {
                "type" : "integer", "minimum" : -128, "maximum" : 127
              },
        "u8" : {
                "type" : "integer", "minimum" : 0, "maximum" :255
              },
        "i16" : {
                "type" : "integer", "minimum" : -32768, "maximum" : 32767
              },
        "u16" : {
                "type" : "integer", "minimum" : 0, "maximum" : 65535
              },
        "i32" : {
                "type" : "integer", "minimum" : -2147483648, "maximum" : 2147483647
              },
        "u32" : {
                "type" : "integer", "minimum" : 0, "maximum" : 4294967295
              },
        "i64" : {
                "type" : "integer", "minimum" : -9223372036854775808, "maximum" : 9223372036854775807
              },
        "u64" : {
                "type" : "integer", "minimum" : 0, "maximum" : 18446744073709551615
              },
        "f32" : {
                "type" : "number"
              },
        "f64" : {
                "type" : "number"
              },
        "v8" : {
                "type" : "array", "items" : {"type" : "integer", "minimum" : -128, "maximum" : 127}
              },
        "vf64" : {
                "type" : "array", "items" : {"type" : "number"}
              }
      },
      "additionalProperties" : false
    }
  },
  "$ref" : "#/definitions/MyGame_Example_Monster"
}