diff --git a/README.md b/README.md index eae063c..77ed7c3 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,7 @@ See `cbindgen --help` for more options. [Read the full user docs here!](docs.md) +[Get a template cbindgen.toml here.](template.toml) diff --git a/docs.md b/docs.md index 5da9f8d..1826843 100644 --- a/docs.md +++ b/docs.md @@ -38,6 +38,8 @@ cbindgen --config cbindgen.toml --crate my_rust_library --output my_header.h` See `cbindgen --help` for more options. +[Get a template cbindgen.toml here.](template.toml) + ## build.rs diff --git a/template.toml b/template.toml new file mode 100644 index 0000000..1bb4a92 --- /dev/null +++ b/template.toml @@ -0,0 +1,142 @@ +# This is a template cbindgen.toml file with all of the default values. +# Some values are commented out because their absence is the real default. +# +# See https://github.com/eqrion/cbindgen/blob/master/docs.md#cbindgentoml +# for detailed documentation of every option here. + + + +language = "C++" + + + +############## Options for Wrapping the Contents of the Header ################# + +# header = "/* Text to put at the beginning of the generated file. Probably a license. */" +# trailer = "/* Text to put at the end of the generated file */" +# include_guard = "my_bindings_h" +# autogen_warning = "/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */" +include_version = false +# namespace = "my_namespace" +namespaces = [] +sys_includes = [] +includes = [] +no_includes = false + + + + +############################ Code Style Options ################################ + +braces = "SameLine" +line_length = 100 +tab_width = 2 +documentation_style = "auto" + + + + + +############################# Codegen Options ################################## + +style = "both" + + + +[defines] +# "target_os = freebsd" = "DEFINE_FREEBSD" +# "feature = serde" = "DEFINE_SERDE" + + + +[export] +include = [] +exclude = [] +# prefix = "CAPI_" +item_types = [] +renaming_overrides_prefixing = false + + + +[export.rename] + + + +[export.body] + + + + +[fn] +rename_args = "None" +# must_use = "MUST_USE_FUNC" +# prefix = "START_FUNC" +# postfix = "END_FUNC" +args = "auto" + + + + +[struct] +rename_fields = "None" +# must_use = "MUST_USE_STRUCT" +derive_constructor = false +derive_eq = false +derive_neq = false +derive_lt = false +derive_lte = false +derive_gt = false +derive_gte = false + + + + +[enum] +rename_variants = "None" +# must_use = "MUST_USE_ENUM" +add_sentinel = false +prefix_with_name = false +derive_helper_methods = false +derive_const_casts = false +derive_mut_casts = false +# cast_assert_name = "ASSERT" +derive_tagged_enum_destructor = false +derive_tagged_enum_copy_constructor = false + + + + +[const] +allow_static_const = true + + + + +[macro_expansion] +bitflags = false + + + + + + +############## Options for How Your Rust library Should Be Parsed ############## + +[parse] +parse_deps = false +# include = [] +exclude = [] +clean = false + + + +[parse.expand] +crates = [] +all_features = false +default_features = true +features = [] + + + + +