Struct wdk_build::Config

pub struct Config {
    pub wdk_content_root: PathBuf,
    pub driver_config: DriverConfig,
    pub cpu_architecture: CPUArchitecture,
}

Configuration parameters for a build dependent on the WDK

Fields

wdk_content_root: PathBuf

Path to root of WDK. Corresponds with WDKContentRoot environment varialbe in eWDK

driver_config: DriverConfig

Build configuration of driver

cpu_architecture: CPUArchitecture

CPU architecture to target

Implementations

impl Config

pub fn new() -> Self

Creates a new Config with default values

pub fn from_env<S: AsRef<str> + Display>( links_value: S ) -> Result<Self, ConfigFromEnvError>

Creates a Config from a config exported from a dependency. The dependency must have exported a Config via Config::export_config, and the dependency must have set a links value in its Cargo manifiest to export the DEP_<CARGO_MANIFEST_LINKS>_WDK_CONFIG to downstream crates

Errors

This function will return an error if the provided links_value does not correspond with a links value specified in the Cargo manifest of one of the dependencies of the crate who’s build script invoked this function.

pub fn from_env_auto() -> Result<Self, ConfigFromEnvError>

Creates a Config from a config exported from wdk or wdk_sys crates.

Errors

This function will return an error if: * an exported config from a dependency on wdk and/or wdk_sys cannot be found * there is a config mismatch between wdk and wdk_sys

pub fn get_include_paths(&self) -> Result<Vec<PathBuf>, ConfigError>

Returns header include paths required to build and link based off of the configuration of Config

Errors

This function will return an error if any of the required paths do not exist.

pub fn get_library_paths(&self) -> Result<Vec<PathBuf>, ConfigError>

Returns library include paths required to build and link based off of the configuration of Config

Errors

This function will return an error if any of the required paths do not exist.

pub fn configure_library_build(&self) -> Result<(), ConfigError>

Configures a Cargo build of a library that directly depends on the WDK (i.e. not transitively via wdk-sys). This emits specially formatted prints to Cargo based on this Config.

This includes header include paths, linker search paths, library link directives, and WDK-specific configuration definitions. This must be called from a Cargo build script of the library.

Errors

This function will return an error if any of the required paths do not exist.

Panics

Panics if the invoked from outside a Cargo build environment

pub fn configure_binary_build(&self)

Configures a Cargo build of a binary that depends on the WDK. This emits specially formatted prints to Cargo based on this Config.

This consists mainly of linker setting configuration. This must be called from a Cargo build script of the binary being built

pub fn export_config(&self) -> Result<(), ExportError>

Serializes this Config and exports it via the Cargo DEP_<CARGO_MANIFEST_LINKS>_WDK_CONFIG environment variable.

Errors

This function will return an error if the crate does not have a links field in its Cargo manifest or if it fails to serialize the config.

Panics

Panics if this Config fails to serialize.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config