Struct Bindgen 

pub struct Bindgen { /* private fields */ }

Builder for generating Windows API bindings.

This is the fluent alternative to bindgen.

Example

windows_bindgen::Bindgen::new()
    .output("src/bindings.rs")
    .filter("GetTickCount")
    .write();

Implementations

impl Bindgen

pub fn new() -> Self

Creates a new builder with default options.

pub fn input(&mut self, input: impl AsRef<Path>) -> &mut Self

Adds a .winmd file or directory.

pub fn input_default(&mut self) -> &mut Self

Adds the default Windows metadata.

pub fn input_bytes(&mut self, input: &[u8]) -> &mut Self

Adds a .winmd file from memory.

pub fn input_byte_sets<I, B>(&mut self, inputs: I) -> &mut Self

where I: IntoIterator<Item = B>, B: AsRef<[u8]>,

Adds .winmd files from memory.

pub fn inputs<I, S>(&mut self, inputs: I) -> &mut Self

where I: IntoIterator<Item = S>, S: AsRef<Path>,

Adds .winmd files or directories.

pub fn output(&mut self, output: impl AsRef<Path>) -> &mut Self

Sets the generated Rust file.

pub fn filter(&mut self, filter: &str) -> &mut Self

Add a filter rule to include or exclude APIs.

Filter rules may be a function or type name, a namespace prefix, a fully-qualified name, or a method-level entry of the form Namespace.Type::Method (with optional Property / Event sugar). Prefix with ! to exclude rather than include. See the crate-level docs for the full grammar.

pub fn filter_file(&mut self, input: impl AsRef<Path>) -> &mut Self

Adds filter rules from a text file.

pub fn filter_files<I, S>(&mut self, inputs: I) -> &mut Self

where I: IntoIterator<Item = S>, S: AsRef<Path>,

Adds filter rules from text files.

pub fn filters<I, S>(&mut self, filters: I) -> &mut Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Add multiple filter rules to include or exclude APIs.

Filter rules may be a function or type name, a namespace prefix, a fully-qualified name, or a method-level entry of the form Namespace.Type::Method (with optional Property / Event sugar). Prefix with ! to exclude rather than include. See the crate-level docs for the full grammar.

pub fn derive(&mut self, derive: &str) -> &mut Self

Add an extra trait for types to derive.

pub fn derives<I, S>(&mut self, derives: I) -> &mut Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Add multiple extra traits for types to derive.

pub fn rustfmt(&mut self, rustfmt: &str) -> &mut Self

Override the default Rust formatter path.

pub fn flat(&mut self) -> &mut Self

Avoid the default namespace-to-module conversion.

pub fn package(&mut self) -> &mut Self

Generate bindings as a package with one file per namespace.

pub fn implement_all(&mut self) -> &mut Self

Includes implementation traits for every WinRT interface in scope.

pub fn implement(&mut self, name: &str) -> &mut Self

Includes implementation traits for a WinRT interface or namespace prefix.

The name may be a fully-qualified type name (Namespace.Name) or a namespace prefix that matches every type defined under it.

pub fn implements<I, S>(&mut self, names: I) -> &mut Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Includes implementation traits for multiple WinRT interfaces or namespace prefixes.

pub fn compose(&mut self, name: &str) -> &mut Self

Selects a composable WinRT class as a minimal-mode composition target.

The class and its composable factory methods must also be selected by a filter.

pub fn composes<I, S>(&mut self, names: I) -> &mut Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Selects multiple composable WinRT classes as minimal-mode composition targets.

pub fn sys(&mut self) -> &mut Self

Generate raw or sys-style Rust bindings.

Mutually exclusive with Bindgen::minimal; panics if minimal was already selected.

pub fn minimal(&mut self) -> &mut Self

Generate minimal-mode Rust bindings.

Drops per-class wrapper methods, inherited interface forwarders, handle ergonomics, and free-function wrappers.

Mutually exclusive with --sys.

pub fn extern_fns(&mut self) -> &mut Self

Generate extern declarations rather than link! macros for sys-style Rust bindings.

Only valid in combination with Bindgen::sys; panics otherwise.

pub fn dead_code(&mut self) -> &mut Self

Emit pub(crate) instead of pub on generated items to surface unused bindings as dead-code warnings.

pub fn write(&self)

Generate the bindings.

Trait Implementations

impl Default for Bindgen

fn default() -> Bindgen

Returns the “default value” for a type.