third_party_rust_link-cplus.../README.md
2022-12-15 17:52:41 -08:00

2.6 KiB

-lstdc++ or -lc++

github crates.io docs.rs build status

This crate exists for the purpose of passing -lstdc++ or -lc++ to the linker, while making it possible for an application to make that choice on behalf of its library dependencies.

Without this crate, a library would need to:

  • pick one or the other to link, with no way for downstream applications to override the choice;
  • or link neither and require an explicit link flag provided by downstream applications even if they would be fine with a default choice;

neither of which are good experiences.


Options

An application or library that is fine with either of libstdc++ or libc++ being linked, whichever is the platform's default, should use the following in Cargo.toml:

[dependencies]
link-cplusplus = "1.0"

An application that wants a particular one or the other linked should use:

[dependencies]
link-cplusplus = { version = "1.0", features = ["libstdc++"] }

# or

link-cplusplus = { version = "1.0", features = ["libc++"] }

An application that wants to handle its own more complicated logic for link flags from its build script can make this crate do nothing by using:

[dependencies]
link-cplusplus = { version = "1.0", features = ["nothing"] }

Lastly, make sure to add an explicit extern crate dependency to your crate root, since the link-cplusplus crate will be otherwise unused and its link flags dropped.

// src/lib.rs

extern crate link_cplusplus;

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.