Struct Opt

#[non_exhaustive]
pub struct Opt {
    pub include: Vec<Include>,
    pub cxx_impl_annotations: Option<String>,
    pub cfg_evaluator: Box<dyn CfgEvaluator>,
    /* private fields */
}

Options for C++ code generation.

We expect options to be added over time, so this is a non-exhaustive struct. To instantiate one you need to crate a default value and mutate those fields that you want to modify.

let impl_annotations = r#"__attribute__((visibility("default")))"#.to_owned();

let mut opt = Opt::default();
opt.cxx_impl_annotations = Some(impl_annotations);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

include: Vec<Include>

Any additional headers to #include. The cxxbridge tool does not parse or even require the given paths to exist; they simply go into the generated C++ code as #include lines.

cxx_impl_annotations: Option<String>

Optional annotation for implementations of C++ function wrappers that may be exposed to Rust. You may for example need to provide __declspec(dllexport) or __attribute__((visibility("default"))) if Rust code from one shared object or executable depends on these C++ functions in another.

cfg_evaluator: Box<dyn CfgEvaluator>

Impl for handling conditional compilation attributes.

Trait Implementations

impl Default for Opt

fn default() -> Self

Returns the “default value” for a type.