Struct cpp_to_rust_common::cpp_build_config::CppBuildPaths

pub struct CppBuildPaths { /* fields omitted */ }

Machine-specific information required to build the C++ wrapper library. This type holds configuration properties that cannot be determined at the time of crate generation because they are always platform-dependent.

By default, all path lists are empty, and the build script doesn't add any extra directories to paths while compiling and linking the crate. If CPP_TO_RUST_LIB_PATHS, CPP_TO_RUST_FRAMEWORK_PATHS or CPP_TO_RUST_INCLUDE_PATHS environment variables are present during execution of the build script, their values are used. A custom build script can get an object of this type using Config::cpp_build_paths_mut and use its API to set extra search paths.

This type is currently only used in cpp_to_rust_build_tools, but cpp_to_rust_generator may start to use it in the future if needed.

Methods

impl CppBuildPaths

fn new() -> CppBuildPaths

Constructs an empty configuration object.

fn add_lib_path<P: Into<PathBuf>>(&mut self, path: P)

Adds path to a lib directory. It's supplied to the linker via -L option or environment variables.

fn add_framework_path<P: Into<PathBuf>>(&mut self, path: P)

Adds path to a framework directory (OS X specific). It's supplied to the linker via -F option or environment variables.

fn add_include_path<P: Into<PathBuf>>(&mut self, path: P)

Adds path to an include directory. It's supplied to the C++ parser and the C++ compiler via -I option.

fn apply_env(&mut self)

If CPP_TO_RUST_LIB_PATHS, CPP_TO_RUST_FRAMEWORK_PATHS or CPP_TO_RUST_INCLUDE_PATHS environment variables are present, their values override current values of the object.

fn lib_paths(&self) -> &[PathBuf]

Returns paths added via add_lib_path.

fn framework_paths(&self) -> &[PathBuf]

Returns paths added via add_framework_path.

fn include_paths(&self) -> &[PathBuf]

Returns paths added via add_include_path.

Trait Implementations

impl Debug for CppBuildPaths

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for CppBuildPaths

fn default() -> CppBuildPaths

Returns the "default value" for a type.

impl Clone for CppBuildPaths

fn clone(&self) -> CppBuildPaths

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.