Struct IncludeCppConfig

pub struct IncludeCppConfig {
    pub inclusions: Vec<String>,
    pub unsafe_policy: UnsafePolicy,
    pub parse_only: bool,
    pub exclude_impls: bool,
    pub allowlist: Allowlist,
    pub instantiable: Vec<String>,
    pub rust_types: Vec<RustPath>,
    pub subclasses: Vec<Subclass>,
    pub extern_rust_funs: Vec<RustFun>,
    pub concretes: ConcretesMap,
    pub externs: ExternCppTypeMap,
    pub opaquelist: Vec<String>,
    /* private fields */
}

Fields

inclusions: Vec<String>

unsafe_policy: UnsafePolicy

parse_only: bool

exclude_impls: bool

allowlist: Allowlist

instantiable: Vec<String>

rust_types: Vec<RustPath>

subclasses: Vec<Subclass>

extern_rust_funs: Vec<RustFun>

concretes: ConcretesMap

externs: ExternCppTypeMap

opaquelist: Vec<String>

Implementations

impl IncludeCppConfig

pub fn get_pod_requests(&self) -> &[String]

pub fn get_mod_name(&self) -> Ident

pub fn exclude_utilities(&self) -> bool

Whether to avoid generating the standard helpful utility functions which we normally include in every mod.

pub fn must_generate_list(&self) -> Box<dyn Iterator<Item = String> + '_>

Items which the user has explicitly asked us to generate; we should raise an error if we weren’t able to do so.

pub fn bindgen_allowlist(&self) -> Option<Box<dyn Iterator<Item = String> + '_>>

The allowlist of items to be passed into bindgen, if any.

pub fn is_on_allowlist(&self, cpp_name: &str) -> bool

Whether this type is on the allowlist specified by the user.

A note on the allowlist handling in general. It’s used in two places:

1. As directives to bindgen
2. After bindgen has generated code, to filter the APIs which we pass to cxx.

This second pass may seem redundant. But sometimes bindgen generates unnecessary stuff.

pub fn is_on_blocklist(&self, cpp_name: &str) -> bool

pub fn is_on_constructor_blocklist(&self, cpp_name: &str) -> bool

pub fn get_blocklist(&self) -> impl Iterator<Item = &String>

pub fn get_opaquelist(&self) -> impl Iterator<Item = &String>

pub fn get_hash(&self) -> u64

Get a hash of the contents of this include_cpp! block.

pub fn uniquify_name_per_mod(&self, name: &str) -> String

In case there are multiple sets of ffi mods in a single binary, endeavor to return a name which can be used to make symbols unique.

pub fn get_makestring_name(&self) -> String

pub fn is_rust_type(&self, id: &Ident) -> bool

pub fn superclasses(&self) -> impl Iterator<Item = &String>

pub fn is_subclass_holder(&self, id: &str) -> bool

pub fn get_rs_filename(&self) -> String

Return the filename to which generated .rs should be written.

pub fn confirm_complete(&mut self)

pub fn replace_included_headers(&mut self, replacement: &str)

Used in reduction to substitute all included headers with a single preprocessed replacement.

Trait Implementations

impl Debug for IncludeCppConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for IncludeCppConfig

fn default() -> IncludeCppConfig

Returns the “default value” for a type.

impl Hash for IncludeCppConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Parse for IncludeCppConfig

fn parse(input: ParseStream<'_>) -> ParseResult<Self>