Struct cmake::Config
[−]
[src]
pub struct Config { /* fields omitted */ }
Builder style configuration for a pending CMake build.
Methods
impl Config
[src]
fn new<P: AsRef<Path>>(path: P) -> Config
[src]
Creates a new blank set of configuration to build the project specified
at the path path
.
fn generator<T: AsRef<OsStr>>(&mut self, generator: T) -> &mut Config
[src]
Sets the build-tool generator (-G
) for this compilation.
fn cflag<P: AsRef<OsStr>>(&mut self, flag: P) -> &mut Config
[src]
Adds a custom flag to pass down to the C compiler, supplementing those that this library already passes.
fn cxxflag<P: AsRef<OsStr>>(&mut self, flag: P) -> &mut Config
[src]
Adds a custom flag to pass down to the C++ compiler, supplementing those that this library already passes.
fn define<K, V>(&mut self, k: K, v: V) -> &mut Config where
K: AsRef<OsStr>,
V: AsRef<OsStr>,
[src]
K: AsRef<OsStr>,
V: AsRef<OsStr>,
Adds a new -D
flag to pass to cmake during the generation step.
fn register_dep(&mut self, dep: &str) -> &mut Config
[src]
Registers a dependency for this compilation on the native library built by Cargo previously.
This registration will modify the CMAKE_PREFIX_PATH
environment
variable for the build system generation step.
fn target(&mut self, target: &str) -> &mut Config
[src]
Sets the target triple for this compilation.
This is automatically scraped from $TARGET
which is set for Cargo
build scripts so it's not necessary to call this from a build script.
fn host(&mut self, host: &str) -> &mut Config
[src]
Sets the host triple for this compilation.
This is automatically scraped from $HOST
which is set for Cargo
build scripts so it's not necessary to call this from a build script.
fn out_dir<P: AsRef<Path>>(&mut self, out: P) -> &mut Config
[src]
Sets the output directory for this compilation.
This is automatically scraped from $OUT_DIR
which is set for Cargo
build scripts so it's not necessary to call this from a build script.
fn profile(&mut self, profile: &str) -> &mut Config
[src]
Sets the profile for this compilation.
This is automatically scraped from $PROFILE
which is set for Cargo
build scripts so it's not necessary to call this from a build script.
fn static_crt(&mut self, static_crt: bool) -> &mut Config
[src]
Configures whether the /MT flag or the /MD flag will be passed to msvc build tools.
This option defaults to false
, and affect only msvc targets.
fn build_arg<A: AsRef<OsStr>>(&mut self, arg: A) -> &mut Config
[src]
Add an argument to the final cmake
build step
fn env<K, V>(&mut self, key: K, value: V) -> &mut Config where
K: AsRef<OsStr>,
V: AsRef<OsStr>,
[src]
K: AsRef<OsStr>,
V: AsRef<OsStr>,
Configure an environment variable for the cmake
processes spawned by
this crate in the build
step.
fn build_target(&mut self, target: &str) -> &mut Config
[src]
Sets the build target for the final cmake
build step, this will
default to "install" if not specified.
fn uses_cxx11(&mut self) -> &mut Config
[src]
Alters the default target triple on OSX to ensure that c++11 is available. Does not change the target triple if it is explicitly specified.
This does not otherwise affect any CXX flags, i.e. it does not set -std=c++11 or -stdlib=libc++.
fn build(&mut self) -> PathBuf
[src]
Run this configuration, compiling the library with all the configured options.
This will run both the build system generator command as well as the command to build the library.