Lines Matching +full:is +full:- +full:binary +full:- +full:path
6 flatc [ GENERATOR OPTIONS ] [ -o PATH ] [ -I PATH ] FILES...
7 [ -- FILES...]
13 `--` indicates that the following files are binary files in
21 - `--cpp`, `-c` : Generate a C++ header for all definitions in this file (as
24 - `--java`, `-j` : Generate Java code.
26 - `--kotlin`, `-k` : Generate Kotlin code.
28 - `--csharp`, `-n` : Generate C# code.
30 - `--go`, `-g` : Generate Go code.
32 - `--python`, `-p`: Generate Python code.
34 - `--js`, `-s`: Generate JavaScript code.
36 - `--ts`: Generate TypeScript code.
38 - `--php`: Generate PHP code.
40 - `--grpc`: Generate RPC stub code for GRPC.
42 - `--dart`: Generate Dart code.
44 - `--lua`: Generate Lua code.
46 - `--lobster`: Generate Lobster code.
48 - `--rust`, `-r` : Generate Rust code.
50 - `--swift`: Generate Swift code.
54 - `--binary`, `-b` : If data is contained in this file, generate a
55 `filename.bin` containing the binary flatbuffer (or a different extension
56 if one is specified in the schema).
58 - `--json`, `-t` : If data is contained in this file, generate a
63 - `-o PATH` : Output all generated files to PATH (either absolute, or
64 relative to the current directory). If omitted, PATH will be the
65 current directory. PATH should end in your systems path separator,
68 - `-I PATH` : when encountering `include` statements, attempt to load the
69 files from this path. Paths will be tried in the order given, and if all
70 fail (or none are specified) it will try to load relative to the path of
73 - `-M` : Print make rules for generated files.
75 - `--strict-json` : Require & generate strict JSON (field names are enclosed
79 - `--allow-non-utf8` : Pass non-UTF-8 input through parser and emit nonstandard
80 \x escapes in JSON. (Default is to raise parse error on non-UTF-8 input.)
82 - `--natural-utf8` : Output strings with UTF-8 as human-readable strings.
83 By default, UTF-8 characters are printed as \uXXXX escapes."
85 - `--defaults-json` : Output fields whose value is equal to the default value
88 - `--no-prefix` : Don't prefix enum values in generated C++ by their enum
91 - `--scoped-enums` : Use C++11 style scoped and strongly typed enums in
92 generated C++. This also implies `--no-prefix`.
94 - `--gen-includes` : (deprecated), this is the default behavior.
95 If the original behavior is required (no include
96 statements) use `--no-includes.`
98 - `--no-includes` : Don't generate include statements for included schemas the
101 - `--gen-mutable` : Generate additional non-const accessors for mutating
102 FlatBuffers in-place.
104 - `--gen-onefile` : Generate single output file for C#, Go, and Python.
106 - `--gen-name-strings` : Generate type name functions for C++.
108 - `--gen-object-api` : Generate an additional object-based API. This API is
113 - `--gen-compare` : Generate operator== for object-based API types.
115 - `--gen-nullable` : Add Clang _Nullable for C++ pointer. or @Nullable for Java.
117 - `--gen-generated` : Add @Generated annotation for Java.
119 - `--gen-jvmstatic` : Add @JvmStatic annotation for Kotlin methods
122 - `--gen-all` : Generate not just code for the current schema files, but
127 - `--cpp-include` : Adds an #include in generated file
129 - `--cpp-ptr-type T` : Set object API pointer type (default std::unique_ptr)
131 - `--cpp-str-type T` : Set object API string type (default std::string)
134 --cpp-str-flex-ctor option to change this behavior).
136 - `--cpp-str-flex-ctor` : Don't construct custom string types by passing
138 construction of custom string types, including zero-copy construction.
140 - `--no-cpp-direct-copy` : Don't generate direct copy methods for C++
141 object-based API.
143 - `--cpp-std CPP_STD` : Generate a C++ code using features of selected C++ standard.
145 * `c++0x` - generate code compatible with old compilers (VS2010),
146 * `c++11` - use C++11 code generator (default),
147 * `c++17` - use C++17 features in generated code (experimental).
149 - `--object-prefix` : Customise class prefix for C++ object-based API.
151 - `--object-suffix` : Customise class suffix for C++ object-based API.
153 - `--go-namespace` : Generate the overrided namespace in Golang.
155 - `--go-import` : Generate the overrided import for flatbuffers in Golang.
156 (default is "github.com/google/flatbuffers/go").
158 - `--raw-binary` : Allow binaries without a file_indentifier to be read.
161 - `--size-prefixed` : Input binaries are size prefixed buffers.
163 - `--proto`: Expect input files to be .proto files (protocol buffers).
166 `import` (use `-I` for paths), `extend`, `oneof`, `group`.
170 - `--oneof-union` : Translate .proto oneofs to flatbuffer unions.
172 - `--grpc` : Generate GRPC interfaces for the specified languages.
174 - `--schema`: Serialize schemas instead of JSON (use with -b). This will
175 output a binary version of the specified schema that itself corresponds
176 to the reflection/reflection.fbs schema. Loading this binary file is the
179 - `--bfbs-comments`: Add doc comments to the binary schema files.
181 - `--conform FILE` : Specify a schema the following schemas should be
185 - `--conform-includes PATH` : Include path for the schema given with
186 `--conform PATH`.
188 - `--filename-suffix SUFFIX` : The suffix appended to the generated
189 file names. Default is '_generated'.
191 - `--filename-ext EXTENSION` : The extension appended to the generated
192 file names. Default is language-specific (e.g. "h" for C++). This
195 - `--include-prefix PATH` : Prefix this path to any generated include
198 - `--keep-prefix` : Keep original prefix of schema include statement.
200 - `--reflect-types` : Add minimal type reflection to code generation.
202 - `--reflect-names` : Add minimal type/name reflection.
204 - `--root-type T` : Select or override the default root_type.
206 - `--require-explicit-ids` : When parsing schemas, require explicit ids (id: x).
208 - `--force-defaults` : Emit default values in binary output from JSON.
210 - `--force-empty` : When serializing from object API representation, force
213 - `--force-empty-vectors` : When serializing from object API representation, force
216 - `--flexbuffers` : Used with "binary" and "json" options, it generates
217 data using schema-less FlexBuffers.
219 - `--no-warnings` : Inhibit all warning messages.
221 - `--cs-global-alias` : Prepend `global::` to all user generated csharp classes and structs.
223 - `--json-nested-bytes` : Allow a nested_flatbuffer field to be parsed as a
224 vector of bytes in JSON, which is unsafe unless checked by a verifier
227 NOTE: short-form options for generators are deprecated, use the long form