Struct ritual_build::Config

pub struct Config { /* fields omitted */ }

Configuration of the build script.

Methods

impl Config

pub fn new() -> Result<Self>

Constructs default configuration state based on information in the generated build_script_data.json file located at the crate root. The caller may change CppBuildPaths and CppBuildConfig values stored in this object and call config.run() to apply them.

pub fn set_current_cpp_library_version(&mut self, version: Option<String>)

pub fn known_targets(&self) -> &[LibraryTarget]

Returns version of the native C++ library used for generating this crate. This is the value set with Config::set_cpp_lib_version during generation, or None if the version was not set.

pub fn cpp_build_config(&self) -> &CppBuildConfig

Returns current CppBuildConfig data.

pub fn cpp_build_config_mut(&mut self) -> &mut CppBuildConfig

Returns mutable CppBuildConfig data.

pub fn set_cpp_build_config(&mut self, config: CppBuildConfig)

Sets new CppBuildConfig data.

pub fn cpp_build_paths(&self) -> &CppBuildPaths

Returns current CppBuildPaths data.

pub fn cpp_build_paths_mut(&mut self) -> &mut CppBuildPaths

Returns mutable CppBuildPaths data.

pub fn set_cpp_build_paths(&mut self, config: CppBuildPaths)

Sets new CppBuildPaths data.

pub fn try_run(self) -> Result<()>

Same as run(), but result of the operation is returned to the caller.

pub fn run(self) -> !

Starts build script with current configuration. The build script performs the following operations:

• Build the C++ wrapper library;
• Generate ffi.rs file with actual link attributes;
• Determine C++ type sizes on current platform and generate sized_types.rs;
• Report linking information to cargo.

This function ends the process with the appropriate error code and never returns to the caller.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.