Struct FindPackageBuilder

pub struct FindPackageBuilder { /* private fields */ }

A builder for creating a CMakePackage instance. An instance of the builder is created by calling the find_package() function. Once the package is configured, FindPackageBuilder::find() will actually try to find the CMake package and return a CMakePackage instance (or error if the package is not found or an error occurs during the search).

Implementations

impl FindPackageBuilder

pub fn version(self, version: impl TryInto<Version>) -> Self

Optionally specifies the minimum required version for the package to find. If the package is not found or the version is too low, the find() method will return Error::Version with the version of the package found on the system.

pub fn components(self, components: impl Into<Vec<String>>) -> Self

Optionally specifies the required components to locate in the package. If the package is found, but any of the components is missing, the package is considered as not found and the find() method will return Error::PackageNotFound. See the documentation on CMake’s find_package() function and how it treats the COMPONENTS argument.

pub fn verbose(self) -> Self

Enable verbose output. This will redirect output from actual execution of the cmake command to the standard output and standard error of the build script.

pub fn find(self) -> Result<CMakePackage, Error>

Tries to find the CMake package on the system. Returns a CMakePackage instance if the package is found, otherwise an error.

Trait Implementations

impl Clone for FindPackageBuilder

fn clone(&self) -> FindPackageBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FindPackageBuilder

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

Formats the value using the given formatter.