| |
@@ -1,4 +1,4 @@
|
| |
- .TH FLATC "1" "June 2022" "" "User Commands"
|
| |
+ .TH FLATC "1" "October 2022" "" "User Commands"
|
| |
.SH NAME
|
| |
.B flatc
|
| |
\(en FlatBuffers compiler
|
| |
@@ -6,7 +6,7 @@
|
| |
.B flatc
|
| |
.RI [ OPTION ]...\:
|
| |
.IR FILE ...\:
|
| |
- .RI [\-\-\ FILE ...]
|
| |
+ .RI [\-\-\ BINARY_FILE ...]
|
| |
.SH OPTIONS
|
| |
.IR FILE s
|
| |
may be schemas (must end in
|
| |
@@ -14,7 +14,7 @@
|
| |
binary schemas (must end in
|
| |
.BR .bfbs ),
|
| |
or JSON files (conforming to preceding schema).
|
| |
- .IR FILE s
|
| |
+ .IR BINARY_FILE s
|
| |
after the
|
| |
.B \-\-
|
| |
must be binary flatbuffer format files.
|
| |
@@ -71,6 +71,9 @@
|
| |
.B \-\-swift
|
| |
Generate Swift files for tables/structs.
|
| |
.TP
|
| |
+ .B \-\-nim
|
| |
+ Generate Nim files for tables/structs.
|
| |
+ .TP
|
| |
.B \-o\ \fIPATH
|
| |
Prefix
|
| |
.I PATH
|
| |
@@ -106,7 +109,7 @@
|
| |
escapes.
|
| |
.TP
|
| |
.B \-\-defaults\-json
|
| |
- Output fields whose value is the default when writing JSON
|
| |
+ Output fields whose value is the default when writing JSON.
|
| |
.TP
|
| |
.B \-\-unknown\-json
|
| |
Allow fields in JSON that are not defined in the schema.
|
| |
@@ -150,7 +153,8 @@
|
| |
.B \-\-gen\-nullable
|
| |
Add Clang
|
| |
.B _Nullable
|
| |
- for C++ pointer. or
|
| |
+ for C++ pointer.
|
| |
+ or
|
| |
.B @Nullable
|
| |
for Java
|
| |
.TP
|
| |
@@ -176,6 +180,9 @@
|
| |
If the language uses a single file for output (by default
|
| |
the case for C++ and JS), all code will end up in this one file.
|
| |
.TP
|
| |
+ .B \-\-gen\-json\-emit
|
| |
+ Generates encoding code which emits Flatbuffers into JSON.
|
| |
+ .TP
|
| |
.B \-\-cpp\-include
|
| |
Adds an
|
| |
.B #include
|
| |
@@ -300,7 +307,7 @@
|
| |
.TP
|
| |
.B \-\-conform\-includes
|
| |
Include path for the schema given with
|
| |
- .B \-\-conform\ \fIPATH
|
| |
+ .BR \-\-conform\ \fIPATH .
|
| |
.TP
|
| |
.B \-\-filename\-suffix
|
| |
The suffix appended to the generated file names.
|
| |
@@ -325,15 +332,23 @@
|
| |
.B \-\-reflect\-names
|
| |
Add minimal type/name reflection.
|
| |
.TP
|
| |
+ .B \-\-rust\-serialize
|
| |
+ Implement
|
| |
+ .B serde::Serialize
|
| |
+ on generated Rust types.
|
| |
+ .TP
|
| |
+ .B \-\-rust\-module\-root\-file
|
| |
+ Generate rust code in individual files with a module root file.
|
| |
+ .TP
|
| |
.B \-\-root\-type\ \fIT
|
| |
- Select or override the default root_type
|
| |
+ Select or override the default root_type.
|
| |
.TP
|
| |
.B \-\-require\-explicit\-ids
|
| |
When parsing schemas, require explicit ids
|
| |
.RB ( id:\ \fIx ).
|
| |
.TP
|
| |
.B \-\-force\-defaults
|
| |
- Emit default values in binary output from JSON
|
| |
+ Emit default values in binary output from JSON.
|
| |
.TP
|
| |
.B \-\-force\-empty
|
| |
When serializing from object API representation,
|
| |
@@ -353,6 +368,43 @@
|
| |
.TP
|
| |
.B \-\-no\-warnings
|
| |
Inhibit all warning messages.
|
| |
+ .TP
|
| |
+ .B \-\-warnings\-as-errors
|
| |
+ Treat all warnings as errors.
|
| |
+ .TP
|
| |
+ .B \-\-cs\-global\-alias
|
| |
+ Prepend
|
| |
+ .RB \(lq global:: \(rq
|
| |
+ to all user generated csharp classes and structs.
|
| |
+ .TP
|
| |
+ .B \-\-cs\-gen\-json\-serializer
|
| |
+ Allows (de)serialization of JSON text in the Object API.
|
| |
+ (requires
|
| |
+ .BR \-\-gen\-object\-api ).
|
| |
+ .TP
|
| |
+ .B \-\-json\-nested\-bytes
|
| |
+ Allow a
|
| |
+ .B nested_flatbuffer
|
| |
+ field to be parsed as a vector of bytes in JSON,
|
| |
+ which is unsafe unless checked by a verifier afterwards.
|
| |
+ .TP
|
| |
+ .B \-\-ts\-flat\-files
|
| |
+ Only generated one typescript file per
|
| |
+ .B .fbs
|
| |
+ file.
|
| |
+ .TP
|
| |
+ .B \-\-annotate\ \fISCHEMA
|
| |
+ Annotate the provided
|
| |
+ .I BINARY_FILE
|
| |
+ with the specified
|
| |
+ .I SCHEMA
|
| |
+ file.
|
| |
+ .TP
|
| |
+ .B \-\-no\-leak\-private\-annotation
|
| |
+ Prevents multiple type of annotations within a Fbs
|
| |
+ .I SCHEMA
|
| |
+ file.
|
| |
+ Currently this is required to generate private types in Rust.
|
| |
.SH EXAMPLES
|
| |
.EX
|
| |
.B flatc\ \-c\ \-b\ schema1.fbs\ schema2.fbs\ data.json
|
| |
The .so version changes due to the new versioning scheme, so this needs a
devel
list announcement with one week’s notice. There are no dependent packages.