How do I specify the linker path in Rust?

by

As stated in the documentation for a build script:

All the lines printed to stdout by a build script [… starting] with cargo: is interpreted directly by Cargo […] rustc-link-search indicates the specified value should be passed to the compiler as a -L flag.

In your Cargo.toml:

[package]
name = "link-example"
version = "0.1.0"
authors = ["An Devloper <[email protected]>"]
build = "build.rs"

And your build.rs:

fn main() {
    println!(r"cargo:rustc-link-search=C:\Rust\linka\libsoundio-1.1.0\i686");
}

Note that your build script can use all the power of Rust and can output different values depending on target platform (e.g. 32- and 64-bit).

Finally, your code:

extern crate libc;

use libc::c_char;
use std::ffi::CStr;

#[link(name = "soundio")]
extern {
    fn soundio_version_string() -> *const c_char;
}

fn main() {
    let v = unsafe { CStr::from_ptr(soundio_version_string()) };
    println!("{:?}", v);
}

The proof is in the pudding:

$ cargo run
    Finished debug [unoptimized + debuginfo] target(s) in 0.0 secs
     Running `target\debug\linka.exe`
"1.0.3"

Ideally, you will create a soundio-sys package, using the convention for *-sys packages. That simply has a build script that links to the appropriate libraries and exposes the C methods. It will use the Cargo links key to uniquely identify the native library and prevent linking to it multiple times. Other libraries can then include this new crate and not worry about those linking details.

More Related Contents:

  1. Package with both a library and a binary?
  2. Why are Rust executables so huge?
  3. How do I ‘pass down’ feature flags to subdependencies in Cargo?
  4. How do I use conditional compilation with `cfg` and Cargo?
  5. How do you enable a Rust “crate feature”?
  6. What is a crate attribute and where do I add it?
  7. How can a Rust program access metadata from its Cargo package?
  8. How to generate statically linked executables?
  9. Can Cargo download and build dependencies without also building the application?
  10. Is there a list of all cfg features?
  11. How to idiomatically alias a crate in Rust 2018?
  12. How to tell what “features” are available per crate?
  13. How can I build multiple binaries with Cargo?
  14. How to pass rustc flags to cargo?
  15. How do I pin indirect dependencies of a crate?
  16. What are Rust’s exact auto-dereferencing rules?
  17. Why is a trait not implemented for a type that clearly has it implemented?
  18. How do I implement a trait I don’t own for a type I don’t own?
  19. What makes something a “trait object”?
  20. Is it possible to use `impl Trait` as a function’s return type in a trait definition?
  21. Cannot borrow as immutable because it is also borrowed as mutable in function arguments
  22. What is the relation between auto-dereferencing and deref coercion?
  23. What is the return type of the indexing operation?
  24. How to do a binary search on a Vec of floats?
  25. Change enum variant while moving the field to the new variant
  26. I implemented a trait for another trait but cannot call methods from both traits
  27. Temporary value is freed at the end of this statement [duplicate]
  28. Sharing a struct with trait objects as properties across threads
  29. Do all primitive types implement the Copy trait?
  30. How do I create a HashMap with type erased keys?

Leave a Comment