Merge pull request #32 from thomcc/extended

Expose most of mimalloc API from libmimalloc-sys

Author: octavonce

.github/workflows/ci.yml

@@ -58,6 +58,12 @@ jobs:
           command: test
           args: --no-default-features
 
+      - name: Test libmimalloc-sys crate bindings.
+        uses: actions-rs/cargo@v1
+        with:
+          command: run
+          args: -p libmimalloc-sys-test
+
   lint:
     name: Rustfmt / Clippy
     runs-on: ubuntu-latest
@@ -84,3 +90,36 @@ jobs:
         with:
           command: clippy
           args: --workspace -- -D warnings
+
+  # Detect cases where documentation links would be dead
+  doc:
+    name: Check documentation
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          override: true
+
+      # Note: We need to use nightly rust, and `cargo rustdoc` (yes, not `cargo
+      # doc`) to actually get it to respect -D warnings... Using nightly also
+      # gets us the nicer syntax for linking to functions, and is in-line with
+      # what docs.rs uses.
+
+      - name: 'Check documentation links in `mimalloc`'
+        uses: actions-rs/cargo@v1
+        with:
+          command: rustdoc
+          args: -- -D warnings
+
+      - name: 'Check documentation links in `libmimalloc-sys`'
+        uses: actions-rs/cargo@v1
+        with:
+          command: rustdoc
+          args: -p libmimalloc-sys -- -D warnings

Cargo.toml

@@ -14,7 +14,7 @@ license = "MIT"
 readme = "README.md"
 
 [workspace]
-members = ["libmimalloc-sys"]
+members = ["libmimalloc-sys", "libmimalloc-sys/sys-test"]
 
 [badges]
 travis-ci = { repository = "purpleprotocol/mimalloc_rust" }

libmimalloc-sys/Cargo.toml

@@ -11,10 +11,16 @@ license = "MIT"
 links = "mimalloc"
 
 [dependencies]
+cty = { version = "0.2", optional = true }
 
 [build-dependencies]
 cmake = "0.1"
 
 [features]
 secure = []
 override = []
+extended = ["cty"]
+
+# Show `extended` on docs.rs since it's the full API surface.
+[package.metadata.docs.rs]
+features = ["extended"]