Merge pull request #648 from gwenn/doctest

doctest README.md

.github/workflows/main.yml

@@ -32,8 +32,9 @@ jobs:
           profile: minimal
           toolchain: stable
           override: true
-      - run: cargo build --features bundled
-      - run: cargo test --features bundled
+      - run: cargo build --features bundled --workspace --all-targets
+      - run: cargo test --features bundled --workspace --all-targets
+      - run: cargo test --features bundled --workspace --doc
       - name: Static build
         if: matrix.platform.os == 'windows-latest'
         shell: cmd

Cargo.toml

@@ -56,6 +56,7 @@ series = ["vtab"]
 # check for invalid query.
 extra_check = []
 modern_sqlite = ["libsqlite3-sys/bundled_bindings"]
+unstable = []
 
 [dependencies]
 time = "0.1.0"
@@ -73,6 +74,7 @@ memchr = "2.2.0"
 uuid = { version = "0.8", optional = true }
 
 [dev-dependencies]
+doc-comment = "0.3"
 tempfile = "3.1.0"
 lazy_static = "1.0"
 regex = "1.0"

README.md

@@ -122,7 +122,7 @@ You can adjust this behavior in a number of ways:
   link against that. This source is embedded in the `libsqlite3-sys` crate and
   is currently SQLite 3.30.1 (as of `rusqlite` 0.21.0 / `libsqlite3-sys`
   0.17.0).  This is probably the simplest solution to any build problems. You can enable this by adding the following in your `Cargo.toml` file:
-  ```
+  ```toml
   [dependencies.rusqlite]
   version = "0.21.0"
   features = ["bundled"]

benches/lib.rs

@@ -1,20 +1,24 @@
-#![feature(test)]
-extern crate test;
+#![cfg_attr(feature = "unstable", feature(test))]
 
-use rusqlite::Connection;
-use test::Bencher;
+#[cfg(feature = "unstable")]
+mod bench {
+    extern crate test;
 
-#[bench]
-fn bench_no_cache(b: &mut Bencher) {
-    let db = Connection::open_in_memory().unwrap();
-    db.set_prepared_statement_cache_capacity(0);
-    let sql = "SELECT 1, 'test', 3.14 UNION SELECT 2, 'exp', 2.71";
-    b.iter(|| db.prepare(sql).unwrap());
-}
+    use rusqlite::Connection;
+    use test::Bencher;
 
-#[bench]
-fn bench_cache(b: &mut Bencher) {
-    let db = Connection::open_in_memory().unwrap();
-    let sql = "SELECT 1, 'test', 3.14 UNION SELECT 2, 'exp', 2.71";
-    b.iter(|| db.prepare_cached(sql).unwrap());
-}
+    #[bench]
+    fn bench_no_cache(b: &mut Bencher) {
+        let db = Connection::open_in_memory().unwrap();
+        db.set_prepared_statement_cache_capacity(0);
+        let sql = "SELECT 1, 'test', 3.14 UNION SELECT 2, 'exp', 2.71";
+        b.iter(|| db.prepare(sql).unwrap());
+    }
+
+    #[bench]
+    fn bench_cache(b: &mut Bencher) {
+        let db = Connection::open_in_memory().unwrap();
+        let sql = "SELECT 1, 'test', 3.14 UNION SELECT 2, 'exp', 2.71";
+        b.iter(|| db.prepare_cached(sql).unwrap());
+    }
+}

src/lib.rs

@@ -900,6 +900,9 @@ unsafe fn db_filename(_: *mut ffi::sqlite3) -> Option<PathBuf> {
     None
 }
 
+#[cfg(doctest)]
+doc_comment::doctest!("../README.md");
+
 #[cfg(test)]
 mod test {
     use super::*;