Struct Clang 

pub struct Clang { /* private fields */ }

Builder that generates RDL from C/C++ headers using libclang.

Implementations

impl Clang

pub fn scrape(&self, plan: &ScrapePlan) -> Summary

Run the plan, replaying this builder once per architecture and merging the results.

impl Clang

pub fn new() -> Self

Creates a builder with default options.

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

Adds an input header (.h) file or directory.

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

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

Adds input headers.

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

Adds inline source text to compile instead of a file on disk.

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

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

Adds inline source texts to compile instead of files on disk.

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

Adds a reference winmd file or directory.

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

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

Adds multiple reference winmd files or directories.

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

Adds a reference winmd from memory.

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

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

Adds reference winmds from memory.

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

Adds the default Windows metadata as references.

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

Sets the output .rdl file path.

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

Sets the namespace for the generated types.

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

Sets the library name recorded for imported functions.

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

Drops functions with no resolved import library; leave off without .lib inputs.

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

Adds a winmd used only to classify ABI::Windows::* projection declarations.

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

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

Adds winmds used only to classify ABI::Windows::* projection declarations.

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

Adds a resolution-only winmd from memory.

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

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

Adds resolution-only winmds from memory.

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

Adds the default Windows Runtime metadata as a resolution-only input.

pub fn libraries<I, K, V>(&mut self, libraries: I) -> &mut Self

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Adds symbol -> DLL overrides for functions.

Prefer per-DLL .lib files over umbrella/apiset libraries for real DLL names.

pub fn resolved_library(&self, symbol: &str) -> Option<&str>

Returns the DLL currently mapped to a function symbol.

pub fn import_library( &mut self, path: impl AsRef<Path>, ) -> Result<&mut Self, Error>

Reads a COFF import library and adds its symbol -> DLL mappings.

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

Adds a normalized header path suffix to the inclusion filter.

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

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

Adds multiple header path suffixes to the inclusion filter.

pub fn arg<S: AsRef<str>>(&mut self, arg: S) -> &mut Self

Adds a compiler argument to pass to libclang.

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

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

Adds multiple compiler arguments to pass to libclang.

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

Sets the target triple used for all clang invocations.

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

Adds a header directory segment that acts as a root for the reachability sweep.

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

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

Adds multiple header directory segments as roots for the reachability sweep.

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

Marks a header as a sweep root regardless of SDK directory.

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

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

Marks multiple headers as sweep roots regardless of SDK directory.

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

Drops a named header partition before the reachability sweep.

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

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

Drops multiple named header partitions before the reachability sweep.

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

Restricts root emission to a named function symbol.

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

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

Restricts root emission to the named function symbols.

pub fn version() -> Result<String, Error>

Returns the version string reported by the loaded libclang.

pub fn write(&self) -> Result<(), Error>

Generates the RDL and writes it to the configured output.

pub fn write_by_header(&self) -> Result<(), Error>

Writes one flat-root RDL file per defining header.

Trait Implementations

impl Clone for Clang

fn clone(&self) -> Clang

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Clang

fn default() -> Clang

Returns the “default value” for a type.