#cargo #cdylib

app cargo-c

Helper program to build and install c-like libraries

5 releases

✓ Uses Rust 2018 edition

0.2.2 Sep 6, 2019
0.2.1 Jul 10, 2019
0.2.0 Jun 28, 2019
0.1.1 Jun 26, 2019
0.1.0 Jun 26, 2019

#35 in Cargo plugins

Download history 47/week @ 2019-06-21 46/week @ 2019-06-28 63/week @ 2019-07-05 24/week @ 2019-07-12 15/week @ 2019-07-19 14/week @ 2019-07-26 25/week @ 2019-08-02 22/week @ 2019-08-09 13/week @ 2019-08-16 43/week @ 2019-08-23 30/week @ 2019-08-30

123 downloads per month

MIT license

33KB
697 lines

Cargo C-ABI helpers

LICENSE dependency status Crates.io Build Status

cargo applet to build and install C-ABI compatibile dynamic and static libraries.

It produces and installs a correct pkg-config file, a static library and a dynamic library, and a C header to be used by any C (and C-compatible) software.

Usage

# build the library, create the .h header, create the .pc file
$ cargo cbuild --destdir=${D} --prefix=/usr --libdir=/usr/lib64
# build the library, create the .h header, create the .pc file and install all of it
$ cargo cinstall --destdir=${D} --prefix=/usr --libdir=/usr/lib64

For a more in-depth explanation of how cargo-c works and how to use it for your crates, read Building Crates so they Look Like C ABI Libraries.

The TL;DR:

  • Create a capi.rs with the C-API you want to expose and use #[cfg(cargo_c)] to hide it when you build a normal rust library.
  • Make sure you have a lib target and if you are using a workspace the first member is the crate you want to export, that means that you might have to add a "." member at the start of the list.
  • Remember to add a [cbindgen.toml][cbinden-toml] and fill it with at least the include guard and probably you want to set the language to C (it defaults to C++)
  • Once you are happy with the result update your documentation to tell the user to install cargo-c and do cargo cinstall --prefix=/usr --destdir=/tmp/some-place or something along those lines.

Users

Status

  • cli
    • build command
    • install command
    • cargo applet support
  • build targets
    • pkg-config generation
    • header generation (cbindgen integration)
  • staticlib support
  • cdylib support
  • Extra Cargo.toml keys
  • Better status reporting

Dependencies

~6.5MB
~138K SLoC