flatbuffers::IDLOptions Struct Reference

#include <idl.h>

Public Types
enum	CaseStyle { CaseStyle_Unchanged = 0 , CaseStyle_Upper , CaseStyle_Lower }
enum class	ProtoIdGapAction { NO_OP , WARNING , ERROR }
enum	Language {   kJava = 1 << 0 , kCSharp = 1 << 1 , kGo = 1 << 2 , kCpp = 1 << 3 ,   kPython = 1 << 5 , kPhp = 1 << 6 , kJson = 1 << 7 , kBinary = 1 << 8 ,   kTs = 1 << 9 , kJsonSchema = 1 << 10 , kDart = 1 << 11 , kLua = 1 << 12 ,   kLobster = 1 << 13 , kRust = 1 << 14 , kKotlin = 1 << 15 , kSwift = 1 << 16 ,   kNim = 1 << 17 , kProto = 1 << 18 , kMAX }
enum	MiniReflect { kNone , kTypes , kTypesAndNames }

Public Member Functions
	IDLOptions ()

Data Fields
bool	gen_jvmstatic
bool	use_flexbuffers
bool	strict_json
bool	output_default_scalars_in_json
int	indent_step
bool	cpp_minify_enums
bool	output_enum_identifiers
bool	prefixed_enums
bool	scoped_enums
bool	emit_min_max_enum_values
bool	swift_implementation_only
bool	include_dependence_headers
bool	mutable_buffer
bool	one_file
bool	proto_mode
bool	proto_oneof_union
bool	generate_all
bool	skip_unexpected_fields_in_json
bool	generate_name_strings
bool	generate_object_based_api
bool	gen_compare
std::string	cpp_object_api_pointer_type
std::string	cpp_object_api_string_type
bool	cpp_object_api_string_flexible_constructor
CaseStyle	cpp_object_api_field_case_style
bool	cpp_direct_copy
bool	gen_nullable
std::string	java_package_prefix
bool	java_checkerframework
bool	gen_generated
bool	gen_json_coders
std::string	object_prefix
std::string	object_suffix
bool	union_value_namespacing
bool	allow_non_utf8
bool	natural_utf8
std::string	include_prefix
bool	keep_prefix
bool	binary_schema_comments
bool	binary_schema_builtins
bool	binary_schema_gen_embed
std::string	go_import
std::string	go_namespace
std::string	go_module_name
bool	protobuf_ascii_alike
bool	size_prefixed
std::string	root_type
bool	force_defaults
bool	java_primitive_has_method
bool	cs_gen_json_serializer
std::vector< std::string >	cpp_includes
std::string	cpp_std
bool	cpp_static_reflection
std::string	proto_namespace_suffix
std::string	filename_suffix
std::string	filename_extension
bool	no_warnings
bool	warnings_as_errors
std::string	project_root
bool	cs_global_alias
bool	json_nested_flatbuffers
bool	json_nested_flexbuffers
bool	json_nested_legacy_flatbuffers
bool	ts_flat_files
bool	ts_entry_points
bool	ts_no_import_ext
bool	no_leak_private_annotations
bool	require_json_eof
bool	keep_proto_id
bool	python_no_type_prefix_suffix
bool	python_typing
ProtoIdGapAction	proto_id_gap_action
MiniReflect	mini_reflect
bool	require_explicit_ids
bool	rust_serialize
bool	rust_module_root_file
unsigned long	lang_to_generate
bool	set_empty_strings_to_null
bool	set_empty_vectors_to_null

Detailed Description

Definition at line 630 of file idl.h.

Member Enumeration Documentation

CaseStyle

enum flatbuffers::IDLOptions::CaseStyle

Enumerator
CaseStyle_Unchanged
CaseStyle_Upper
CaseStyle_Lower

Definition at line 632 of file idl.h.

{ CaseStyle_Unchanged = 0, CaseStyle_Upper, CaseStyle_Lower };

Language

enum flatbuffers::IDLOptions::Language

Enumerator
kJava
kCSharp
kGo
kCpp
kPython
kPhp
kJson
kBinary
kTs
kJsonSchema
kDart
kLua
kLobster
kRust
kKotlin
kSwift
kNim
kProto
kMAX

Definition at line 709 of file idl.h.

                {
    kJava = 1 << 0,
    kCSharp = 1 << 1,
    kGo = 1 << 2,
    kCpp = 1 << 3,
    kPython = 1 << 5,
    kPhp = 1 << 6,
    kJson = 1 << 7,
    kBinary = 1 << 8,
    kTs = 1 << 9,
    kJsonSchema = 1 << 10,
    kDart = 1 << 11,
    kLua = 1 << 12,
    kLobster = 1 << 13,
    kRust = 1 << 14,
    kKotlin = 1 << 15,
    kSwift = 1 << 16,
    kNim = 1 << 17,
    kProto = 1 << 18,
    kMAX
  };

MiniReflect

enum flatbuffers::IDLOptions::MiniReflect

Enumerator
kNone
kTypes
kTypesAndNames

Definition at line 731 of file idl.h.

{ kNone, kTypes, kTypesAndNames };

ProtoIdGapAction

enum class flatbuffers::IDLOptions::ProtoIdGapAction

strong

Enumerator
NO_OP
WARNING
ERROR

Definition at line 633 of file idl.h.

{ NO_OP, WARNING, ERROR };

Constructor & Destructor Documentation

IDLOptions()

flatbuffers::IDLOptions::IDLOptions ( )

inline

Definition at line 756 of file idl.h.

      : gen_jvmstatic(false),
        use_flexbuffers(false),
        strict_json(false),
        output_default_scalars_in_json(false),
        indent_step(2),
        cpp_minify_enums(false),
        output_enum_identifiers(true),
        prefixed_enums(true),
        scoped_enums(false),
        emit_min_max_enum_values(true),
        swift_implementation_only(false),
        include_dependence_headers(true),
        mutable_buffer(false),
        one_file(false),
        proto_mode(false),
        proto_oneof_union(false),
        generate_all(false),
        skip_unexpected_fields_in_json(false),
        generate_name_strings(false),
        generate_object_based_api(false),
        gen_compare(false),
        cpp_object_api_pointer_type("std::unique_ptr"),
        cpp_object_api_string_flexible_constructor(false),
        cpp_object_api_field_case_style(CaseStyle_Unchanged),
        cpp_direct_copy(true),
        gen_nullable(false),
        java_checkerframework(false),
        gen_generated(false),
        gen_json_coders(false),
        object_suffix("T"),
        union_value_namespacing(true),
        allow_non_utf8(false),
        natural_utf8(false),
        keep_prefix(false),
        binary_schema_comments(false),
        binary_schema_builtins(false),
        binary_schema_gen_embed(false),
        protobuf_ascii_alike(false),
        size_prefixed(false),
        force_defaults(false),
        java_primitive_has_method(false),
        cs_gen_json_serializer(false),
        cpp_static_reflection(false),
        filename_suffix("_generated"),
        filename_extension(),
        no_warnings(false),
        warnings_as_errors(false),
        project_root(""),
        cs_global_alias(false),
        json_nested_flatbuffers(true),
        json_nested_flexbuffers(true),
        json_nested_legacy_flatbuffers(false),
        ts_flat_files(false),
        ts_entry_points(false),
        ts_no_import_ext(false),
        no_leak_private_annotations(false),
        require_json_eof(true),
        keep_proto_id(false),
        python_no_type_prefix_suffix(false),
        python_typing(false),
        proto_id_gap_action(ProtoIdGapAction::WARNING),
        mini_reflect(IDLOptions::kNone),
        require_explicit_ids(false),
        rust_serialize(false),
        rust_module_root_file(false),
        lang_to_generate(0),
        set_empty_strings_to_null(true),
        set_empty_vectors_to_null(true) {}

Field Documentation

allow_non_utf8

bool flatbuffers::IDLOptions::allow_non_utf8

Definition at line 669 of file idl.h.

binary_schema_builtins

bool flatbuffers::IDLOptions::binary_schema_builtins

Definition at line 674 of file idl.h.

binary_schema_comments

bool flatbuffers::IDLOptions::binary_schema_comments

Definition at line 673 of file idl.h.

binary_schema_gen_embed

bool flatbuffers::IDLOptions::binary_schema_gen_embed

Definition at line 675 of file idl.h.

cpp_direct_copy

bool flatbuffers::IDLOptions::cpp_direct_copy

Definition at line 660 of file idl.h.

cpp_includes

std::vector<std::string> flatbuffers::IDLOptions::cpp_includes

Definition at line 685 of file idl.h.

cpp_minify_enums

bool flatbuffers::IDLOptions::cpp_minify_enums

Definition at line 640 of file idl.h.

cpp_object_api_field_case_style

CaseStyle flatbuffers::IDLOptions::cpp_object_api_field_case_style

Definition at line 659 of file idl.h.

cpp_object_api_pointer_type

std::string flatbuffers::IDLOptions::cpp_object_api_pointer_type

Definition at line 656 of file idl.h.

cpp_object_api_string_flexible_constructor

bool flatbuffers::IDLOptions::cpp_object_api_string_flexible_constructor

Definition at line 658 of file idl.h.

cpp_object_api_string_type

std::string flatbuffers::IDLOptions::cpp_object_api_string_type

Definition at line 657 of file idl.h.

cpp_static_reflection

bool flatbuffers::IDLOptions::cpp_static_reflection

Definition at line 687 of file idl.h.

cpp_std

std::string flatbuffers::IDLOptions::cpp_std

Definition at line 686 of file idl.h.

cs_gen_json_serializer

bool flatbuffers::IDLOptions::cs_gen_json_serializer

Definition at line 684 of file idl.h.

cs_global_alias

bool flatbuffers::IDLOptions::cs_global_alias

Definition at line 694 of file idl.h.

emit_min_max_enum_values

bool flatbuffers::IDLOptions::emit_min_max_enum_values

Definition at line 644 of file idl.h.

filename_extension

std::string flatbuffers::IDLOptions::filename_extension

Definition at line 690 of file idl.h.

filename_suffix

std::string flatbuffers::IDLOptions::filename_suffix

Definition at line 689 of file idl.h.

force_defaults

bool flatbuffers::IDLOptions::force_defaults

Definition at line 682 of file idl.h.

Referenced by flatbuffers::Parser::Parser().

gen_compare

bool flatbuffers::IDLOptions::gen_compare

Definition at line 655 of file idl.h.

gen_generated

bool flatbuffers::IDLOptions::gen_generated

Definition at line 664 of file idl.h.

gen_json_coders

bool flatbuffers::IDLOptions::gen_json_coders

Definition at line 665 of file idl.h.

gen_jvmstatic

bool flatbuffers::IDLOptions::gen_jvmstatic

Definition at line 634 of file idl.h.

gen_nullable

bool flatbuffers::IDLOptions::gen_nullable

Definition at line 661 of file idl.h.

generate_all

bool flatbuffers::IDLOptions::generate_all

Definition at line 651 of file idl.h.

generate_name_strings

bool flatbuffers::IDLOptions::generate_name_strings

Definition at line 653 of file idl.h.

generate_object_based_api

bool flatbuffers::IDLOptions::generate_object_based_api

Definition at line 654 of file idl.h.

go_import

std::string flatbuffers::IDLOptions::go_import

Definition at line 676 of file idl.h.

go_module_name

std::string flatbuffers::IDLOptions::go_module_name

Definition at line 678 of file idl.h.

go_namespace

std::string flatbuffers::IDLOptions::go_namespace

Definition at line 677 of file idl.h.

include_dependence_headers

bool flatbuffers::IDLOptions::include_dependence_headers

Definition at line 646 of file idl.h.

include_prefix

std::string flatbuffers::IDLOptions::include_prefix

Definition at line 671 of file idl.h.

indent_step

int flatbuffers::IDLOptions::indent_step

Definition at line 639 of file idl.h.

java_checkerframework

bool flatbuffers::IDLOptions::java_checkerframework

Definition at line 663 of file idl.h.

java_package_prefix

std::string flatbuffers::IDLOptions::java_package_prefix

Definition at line 662 of file idl.h.

java_primitive_has_method

bool flatbuffers::IDLOptions::java_primitive_has_method

Definition at line 683 of file idl.h.

json_nested_flatbuffers

bool flatbuffers::IDLOptions::json_nested_flatbuffers

Definition at line 695 of file idl.h.

json_nested_flexbuffers

bool flatbuffers::IDLOptions::json_nested_flexbuffers

Definition at line 696 of file idl.h.

json_nested_legacy_flatbuffers

bool flatbuffers::IDLOptions::json_nested_legacy_flatbuffers

Definition at line 697 of file idl.h.

keep_prefix

bool flatbuffers::IDLOptions::keep_prefix

Definition at line 672 of file idl.h.

keep_proto_id

bool flatbuffers::IDLOptions::keep_proto_id

Definition at line 703 of file idl.h.

lang_to_generate

unsigned long flatbuffers::IDLOptions::lang_to_generate

Definition at line 746 of file idl.h.

mini_reflect

MiniReflect flatbuffers::IDLOptions::mini_reflect

Definition at line 733 of file idl.h.

mutable_buffer

bool flatbuffers::IDLOptions::mutable_buffer

Definition at line 647 of file idl.h.

natural_utf8

bool flatbuffers::IDLOptions::natural_utf8

Definition at line 670 of file idl.h.

no_leak_private_annotations

bool flatbuffers::IDLOptions::no_leak_private_annotations

Definition at line 701 of file idl.h.

no_warnings

bool flatbuffers::IDLOptions::no_warnings

Definition at line 691 of file idl.h.

object_prefix

std::string flatbuffers::IDLOptions::object_prefix

Definition at line 666 of file idl.h.

object_suffix

std::string flatbuffers::IDLOptions::object_suffix

Definition at line 667 of file idl.h.

one_file

bool flatbuffers::IDLOptions::one_file

Definition at line 648 of file idl.h.

output_default_scalars_in_json

bool flatbuffers::IDLOptions::output_default_scalars_in_json

Definition at line 638 of file idl.h.

output_enum_identifiers

bool flatbuffers::IDLOptions::output_enum_identifiers

Definition at line 641 of file idl.h.

prefixed_enums

bool flatbuffers::IDLOptions::prefixed_enums

Definition at line 642 of file idl.h.

project_root

std::string flatbuffers::IDLOptions::project_root

Definition at line 693 of file idl.h.

proto_id_gap_action

ProtoIdGapAction flatbuffers::IDLOptions::proto_id_gap_action

Definition at line 706 of file idl.h.

proto_mode

bool flatbuffers::IDLOptions::proto_mode

Definition at line 649 of file idl.h.

proto_namespace_suffix

std::string flatbuffers::IDLOptions::proto_namespace_suffix

Definition at line 688 of file idl.h.

proto_oneof_union

bool flatbuffers::IDLOptions::proto_oneof_union

Definition at line 650 of file idl.h.

protobuf_ascii_alike

bool flatbuffers::IDLOptions::protobuf_ascii_alike

Definition at line 679 of file idl.h.

python_no_type_prefix_suffix

bool flatbuffers::IDLOptions::python_no_type_prefix_suffix

Definition at line 704 of file idl.h.

python_typing

bool flatbuffers::IDLOptions::python_typing

Definition at line 705 of file idl.h.

require_explicit_ids

bool flatbuffers::IDLOptions::require_explicit_ids

Definition at line 736 of file idl.h.

require_json_eof

bool flatbuffers::IDLOptions::require_json_eof

Definition at line 702 of file idl.h.

root_type

std::string flatbuffers::IDLOptions::root_type

Definition at line 681 of file idl.h.

rust_module_root_file

bool flatbuffers::IDLOptions::rust_module_root_file

Definition at line 742 of file idl.h.

rust_serialize

bool flatbuffers::IDLOptions::rust_serialize

Definition at line 739 of file idl.h.

scoped_enums

bool flatbuffers::IDLOptions::scoped_enums

Definition at line 643 of file idl.h.

set_empty_strings_to_null

bool flatbuffers::IDLOptions::set_empty_strings_to_null

Definition at line 750 of file idl.h.

set_empty_vectors_to_null

bool flatbuffers::IDLOptions::set_empty_vectors_to_null

Definition at line 754 of file idl.h.

size_prefixed

bool flatbuffers::IDLOptions::size_prefixed

Definition at line 680 of file idl.h.

skip_unexpected_fields_in_json

bool flatbuffers::IDLOptions::skip_unexpected_fields_in_json

Definition at line 652 of file idl.h.

strict_json

bool flatbuffers::IDLOptions::strict_json

Definition at line 637 of file idl.h.

swift_implementation_only

bool flatbuffers::IDLOptions::swift_implementation_only

Definition at line 645 of file idl.h.

ts_entry_points

bool flatbuffers::IDLOptions::ts_entry_points

Definition at line 699 of file idl.h.

ts_flat_files

bool flatbuffers::IDLOptions::ts_flat_files

Definition at line 698 of file idl.h.

ts_no_import_ext

bool flatbuffers::IDLOptions::ts_no_import_ext

Definition at line 700 of file idl.h.

union_value_namespacing

bool flatbuffers::IDLOptions::union_value_namespacing

Definition at line 668 of file idl.h.

use_flexbuffers

bool flatbuffers::IDLOptions::use_flexbuffers

Definition at line 636 of file idl.h.

warnings_as_errors

bool flatbuffers::IDLOptions::warnings_as_errors

Definition at line 692 of file idl.h.

---

The documentation for this struct was generated from the following file:

• onert-micro/externals/flatbuffers/idl.h