Struct QtBuild 

pub struct QtBuild { /* private fields */ }

Helper for build.rs scripts using Qt

let qt_modules = vec!["Core", "Gui"]
    .iter()
    .map(|m| String::from(*m))
    .collect();
let qtbuild = qt_build_utils::QtBuild::new(qt_modules).expect("Could not find Qt installation");

Implementations

impl QtBuild

pub fn new(qt_modules: Vec<String>) -> Result<Self>

Create a QtBuild automatically determining the QtInstallation depending on enable features and specify which Qt modules you are linking, ommitting the Qt prefix ("Core" rather than "QtCore").

pub fn with_installation( qt_installation: Box<dyn QtInstallation>, qt_modules: Vec<String>, ) -> Self

Create a QtBuild using the given QtInstallation and specify which Qt modules you are linking, ommitting the Qt prefix ("Core" rather than "QtCore").

pub fn autorcc_options( self, options: impl IntoIterator<Item = impl AsRef<OsStr>>, ) -> Self

Add custom arguments to be passed to the end of the rcc invocation when converting qrc files.

pub fn cargo_link_libraries(&self, builder: &mut Build)

Tell Cargo to link each Qt module.

pub fn framework_paths(&self) -> Vec<PathBuf>

Get the frmaework paths for Qt. This is intended to be passed to whichever tool you are using to invoke the C++ compiler.

pub fn include_paths(&self) -> Vec<PathBuf>

Get the include paths for Qt, including Qt module subdirectories. This is intended to be passed to whichever tool you are using to invoke the C++ compiler.

pub fn installation(&self) -> &dyn QtInstallation

Get the inner QtInstallation implementation

pub fn version(&self) -> Version

Version of the detected Qt installation

pub fn moc(&mut self) -> QtToolMoc

Create a QtToolMoc for this QtBuild

This allows for using moc

pub fn register_qml_module( &mut self, metatypes_json: &[impl AsRef<Path>], uri: &QmlUri, version_major: usize, version_minor: usize, plugin_name: &str, qml_files: &[QmlFile], depends: impl IntoIterator<Item = impl Into<QmlUri>>, plugin_type: PluginType, ) -> QmlModuleRegistrationFiles

Generate C++ files to automatically register a QML module at build time using the JSON output from moc.

This generates a qmldir file for the QML module. The qml_files and qrc_files are registered with the Qt Resource System in the default QML import path qrc:/qt/qml/uri/of/module/.

When using Qt 6, this will run qmlcachegen to compile the specified .qml files ahead-of-time.

pub fn rcc(&self) -> QtToolRcc

Create a QtToolRcc for this QtBuild

This allows for using rcc

pub fn qmltyperegistrar(&self) -> QtToolQmlTypeRegistrar

Create a QtToolQmlTypeRegistrar for this QtBuild

pub fn qtpaths(&self) -> QtToolQtPaths

Create a QtToolQtPaths for this QtBuild