Struct LocalLibrary

pub struct LocalLibrary { /* private fields */ }

Local library configuration.

This contains all the information required to link against a local library.

Implementations

impl LocalLibrary

pub fn new(install_directory: &Path) -> LocalLibrary

Create a new LocalLibrary instance from a specific path.

This is useful when you want to ship binaries with your crate.

pub fn from(repository: CMakeBuilder) -> LocalLibrary

Create a new LocalLibrary instance from a CMakeBuilder.

pub fn add_include_directory(&mut self, path: &Path) -> &mut LocalLibrary

Add a directory that will be searched for include files.

The path should be relative to the installation directory.

pub fn add_library_directory(&mut self, path: &Path) -> &mut LocalLibrary

Add a directory that will be searched for library files.

The path should be relative to the installation directory.

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

Add a target to link against.

Before linking, the crate will check if the library exists. If it finds a static and shared library with the same name, it will always prefer the static library.

When linking against a shared library, the shared object will be copied to the target directory.

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

Add a system target to link against.

Unlike link_target, this will not check if the library exists and will always assume that the library is shared and available on the system.

system link targets will not be copied to the target directory.

pub fn get(&self) -> LocalLibrary

Finalize the LocalLibrary configuration.

Trait Implementations

impl Clone for LocalLibrary

fn clone(&self) -> LocalLibrary

Returns a copy of the value.

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

Performs copy-assignment from source.