Struct autocxx_parser::TypeConfig

pub struct TypeConfig(_);

Configuration about types. At present this is very minimal; in future we should roll known_types.rs into this and possibly other things as well. This type can only be created once we know that the allowlist is specified.

Implementations

impl TypeConfig

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

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 get_blocklist(&self) -> impl Iterator<Item = &String>

pub fn new_for_test() -> Self

Trait Implementations

impl Debug for TypeConfig

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

Formats the value using the given formatter.

impl Hash for TypeConfig

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.