Struct vcpkg::Config

pub struct Config { /* fields omitted */ }

Configuration options for finding packages, setting up the tree and emitting metadata to cargo

Implementations

impl Config

pub fn new() -> Config

pub fn find_package(&mut self, port_name: &str) -> Result<Library, Error>

Find the package port_name in a Vcpkg tree.

Emits cargo metadata to link to libraries provided by the Vcpkg package/port named, and any (non-system) libraries that they depend on.

This will select the architecture and linkage based on environment variables and build flags as described in the module docs, and any configuration set on the builder.

pub fn cargo_metadata(&mut self, cargo_metadata: bool) -> &mut Config

Define whether metadata should be emitted for cargo allowing it to automatically link the binary. Defaults to true.

pub fn emit_includes(&mut self, emit_includes: bool) -> &mut Config

Define cargo:include= metadata should be emitted. Defaults to false.

pub fn copy_dlls(&mut self, copy_dlls: bool) -> &mut Config

Should DLLs be copied to OUT_DIR? Defaults to true.

pub fn vcpkg_root(&mut self, vcpkg_root: PathBuf) -> &mut Config

Define which path to use as vcpkg root overriding the VCPKG_ROOT environment variable Default to None, which means use VCPKG_ROOT or try to find out automatically

pub fn target_triplet<S: AsRef<str>>(&mut self, triplet: S) -> &mut Config

Specify target triplet. When triplet is not specified, inferred triplet from rust target is used.

Specifying a triplet using target_triplet will override the default triplet for this crate. This cannot change the choice of triplet made by other crates, so a safer choice will be to set VCPKGRS_TRIPLET in the environment which will allow all crates to use a consistent set of external dependencies.

pub fn lib_name(&mut self, lib_stem: &str) -> &mut Config

Override the name of the library to look for if it differs from the package name.

It should not be necessary to use lib_name anymore. Calling find_package with a package name will result in the correct library names. This may be called more than once if multiple libs are required. All libs must be found for the probe to succeed. .probe() must be run with a different configuration to look for libraries under one of several names. .libname("ssleay32") will look for ssleay32.lib and also ssleay32.dll if dynamic linking is selected.

pub fn lib_names(&mut self, lib_stem: &str, dll_stem: &str) -> &mut Config

Override the name of the library to look for if it differs from the package name.

It should not be necessary to use lib_names anymore. Calling find_package with a package name will result in the correct library names. This may be called more than once if multiple libs are required. All libs must be found for the probe to succeed. .probe() must be run with a different configuration to look for libraries under one of several names. .lib_names("libcurl_imp","curl") will look for libcurl_imp.lib and also curl.dll if dynamic linking is selected.

Trait Implementations

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.