Merge pull request #241 from aleksuss/get-cf-names

Some doc-tests refactoring

src/compaction_filter.rs

@@ -131,4 +131,6 @@ fn compaction_filter_test() {
         assert!(db.get(b"_k").unwrap().is_none());
         assert_eq!(&*db.get(b"%k").unwrap().unwrap(), b"secret");
     }
+    let result = DB::destroy(&opts, path);
+    assert!(result.is_ok());
 }

src/db.rs

@@ -67,16 +67,18 @@ pub enum DBRecoveryMode {
 /// Making an atomic commit of several writes:
 ///
 /// ```
-/// use rocksdb::{DB, WriteBatch};
+/// use rocksdb::{DB, Options, WriteBatch};
 ///
-/// let db = DB::open_default("path/for/rocksdb/storage1").unwrap();
+/// let path = "_path_for_rocksdb_storage1";
 /// {
+///     let db = DB::open_default(path).unwrap();
 ///     let mut batch = WriteBatch::default();
 ///     batch.put(b"my key", b"my value");
 ///     batch.put(b"key2", b"value2");
 ///     batch.put(b"key3", b"value3");
 ///     db.write(batch); // Atomically commits the batch
 /// }
+/// let _ = DB::destroy(&Options::default(), path);
 /// ```
 pub struct WriteBatch {
     inner: *mut ffi::rocksdb_writebatch_t,
@@ -89,11 +91,15 @@ pub struct ReadOptions {
 /// A consistent view of the database at the point of creation.
 ///
 /// ```
-/// use rocksdb::{DB, IteratorMode};
+/// use rocksdb::{DB, IteratorMode, Options};
 ///
-/// let db = DB::open_default("path/for/rocksdb/storage3").unwrap();
+/// let path = "_path_for_rocksdb_storage3";
+/// {
+///     let db = DB::open_default(path).unwrap();
 ///     let snapshot = db.snapshot(); // Creates a longer-term snapshot of the DB, but closed when goes out of scope
 ///     let mut iter = snapshot.iterator(IteratorMode::Start); // Make as many iterators as you'd like from one snapshot
+/// }
+/// let _ = DB::destroy(&Options::default(), path);
 /// ```
 ///
 pub struct Snapshot<'a> {
@@ -110,9 +116,11 @@ pub struct Snapshot<'a> {
 /// widely recognised Rust idioms.
 ///
 /// ```
-/// use rocksdb::DB;
+/// use rocksdb::{DB, Options};
 ///
-/// let mut db = DB::open_default("path/for/rocksdb/storage4").unwrap();
+/// let path = "_path_for_rocksdb_storage4";
+/// {
+///     let db = DB::open_default(path).unwrap();
 ///     let mut iter = db.raw_iterator();
 ///
 ///     // Forwards iteration
@@ -144,6 +152,8 @@ pub struct Snapshot<'a> {
 ///         println!("Saw {:?} {:?}", iter.key(), iter.value());
 ///         iter.prev();
 ///     }
+/// }
+/// let _ = DB::destroy(&Options::default(), path);
 /// ```
 pub struct DBRawIterator {
     inner: *mut ffi::rocksdb_iterator_t,
@@ -153,9 +163,11 @@ pub struct DBRawIterator {
 /// ranges and direction.
 ///
 /// ```
-/// use rocksdb::{DB, Direction, IteratorMode};
+/// use rocksdb::{DB, Direction, IteratorMode, Options};
 ///
-/// let mut db = DB::open_default("path/for/rocksdb/storage2").unwrap();
+/// let path = "_path_for_rocksdb_storage2";
+/// {
+///     let db = DB::open_default(path).unwrap();
 ///     let mut iter = db.iterator(IteratorMode::Start); // Always iterates forward
 ///     for (key, value) in iter {
 ///         println!("Saw {:?} {:?}", key, value);
@@ -175,6 +187,8 @@ pub struct DBRawIterator {
 ///     for (key, value) in iter {
 ///         println!("Saw {:?} {:?}", key, value);
 ///     }
+/// }
+/// let _ = DB::destroy(&Options::default(), path);
 /// ```
 pub struct DBIterator {
     raw: DBRawIterator,
@@ -228,23 +242,22 @@ impl DBRawIterator {
     /// # Examples
     ///
     /// ```rust
-    /// use rocksdb::DB;
+    /// use rocksdb::{DB, Options};
     ///
-    /// let mut db = DB::open_default("path/for/rocksdb/storage5").unwrap();
+    /// let path = "_path_for_rocksdb_storage5";
+    /// {
+    ///     let db = DB::open_default(path).unwrap();
     ///     let mut iter = db.raw_iterator();
     ///
     ///     // Iterate all keys from the start in lexicographic order
-    ///
     ///     iter.seek_to_first();
     ///
     ///     while iter.valid() {
     ///         println!("{:?} {:?}", iter.key(), iter.value());
-    ///
     ///         iter.next();
     ///     }
     ///
     ///     // Read just the first key
-    ///
     ///     iter.seek_to_first();
     ///
     ///     if iter.valid() {
@@ -252,6 +265,8 @@ impl DBRawIterator {
     ///     } else {
     ///         // There are no keys in the database
     ///     }
+    /// }
+    /// let _ = DB::destroy(&Options::default(), path);
     /// ```
     pub fn seek_to_first(&mut self) {
         unsafe {
@@ -264,23 +279,22 @@ impl DBRawIterator {
     /// # Examples
     ///
     /// ```rust
-    /// use rocksdb::DB;
+    /// use rocksdb::{DB, Options};
     ///
-    /// let mut db = DB::open_default("path/for/rocksdb/storage6").unwrap();
+    /// let path = "_path_for_rocksdb_storage6";
+    /// {
+    ///     let db = DB::open_default(path).unwrap();
     ///     let mut iter = db.raw_iterator();
     ///
     ///     // Iterate all keys from the end in reverse lexicographic order
-    ///
     ///     iter.seek_to_last();
     ///
     ///     while iter.valid() {
     ///         println!("{:?} {:?}", iter.key(), iter.value());
-    ///
     ///         iter.prev();
     ///     }
     ///
     ///     // Read just the last key
-    ///
     ///     iter.seek_to_last();
     ///
     ///     if iter.valid() {
@@ -288,6 +302,8 @@ impl DBRawIterator {
     ///     } else {
     ///         // There are no keys in the database
     ///     }
+    /// }
+    /// let _ = DB::destroy(&Options::default(), path);
     /// ```
     pub fn seek_to_last(&mut self) {
         unsafe {
@@ -303,13 +319,14 @@ impl DBRawIterator {
     /// # Examples
     ///
     /// ```rust
-    /// use rocksdb::DB;
+    /// use rocksdb::{DB, Options};
     ///
-    /// let mut db = DB::open_default("path/for/rocksdb/storage7").unwrap();
+    /// let path = "_path_for_rocksdb_storage7";
+    /// {
+    ///     let db = DB::open_default(path).unwrap();
     ///     let mut iter = db.raw_iterator();
     ///
     ///     // Read the first key that starts with 'a'
-    ///
     ///     iter.seek(b"a");
     ///
     ///     if iter.valid() {
@@ -317,6 +334,8 @@ impl DBRawIterator {
     ///     } else {
     ///         // There are no keys in the database
     ///     }
+    /// }
+    /// let _ = DB::destroy(&Options::default(), path);
     /// ```
     pub fn seek(&mut self, key: &[u8]) {
         unsafe {
@@ -337,13 +356,14 @@ impl DBRawIterator {
     /// # Examples
     ///
     /// ```rust
-    /// use rocksdb::DB;
+    /// use rocksdb::{DB, Options};
     ///
-    /// let mut db = DB::open_default("path/for/rocksdb/storage8").unwrap();
+    /// let path = "_path_for_rocksdb_storage8";
+    /// {
+    ///     let db = DB::open_default(path).unwrap();
     ///     let mut iter = db.raw_iterator();
     ///
     ///     // Read the last key that starts with 'a'
-    ///
     ///     iter.seek_for_prev(b"b");
     ///
     ///     if iter.valid() {
@@ -351,6 +371,9 @@ impl DBRawIterator {
     ///     } else {
     ///         // There are no keys in the database
     ///     }
+    /// }
+    /// let _ = DB::destroy(&Options::default(), path);
+    /// ```
     pub fn seek_for_prev(&mut self, key: &[u8]) {
         unsafe {
             ffi::rocksdb_iter_seek_for_prev(
@@ -640,9 +663,7 @@ impl DB {
 
         if let Err(e) = fs::create_dir_all(&path) {
             return Err(Error::new(format!(
-                "Failed to create RocksDB\
+                "Failed to create RocksDB directory: `{:?}`.", e
-                 directory: `{:?}`.",
-                e
             )));
         }
 
@@ -719,17 +740,7 @@ impl DB {
     }
 
     pub fn list_cf<P: AsRef<Path>>(opts: &Options, path: P) -> Result<Vec<String>, Error> {
-        let cpath = match CString::new(path.as_ref().to_string_lossy().as_bytes()) {
+        let cpath = to_cpath(path)?;
-            Ok(c) => c,
-            Err(_) => {
-                return Err(Error::new(
-                    "Failed to convert path to CString \
-                     when opening DB."
-                        .to_owned(),
-                ))
-            }
-        };
-
         let mut length = 0;
 
         unsafe {
@@ -749,7 +760,7 @@ impl DB {
     }
 
     pub fn destroy<P: AsRef<Path>>(opts: &Options, path: P) -> Result<(), Error> {
-        let cpath = CString::new(path.as_ref().to_string_lossy().as_bytes()).unwrap();
+        let cpath = to_cpath(path)?;
         unsafe {
             ffi_try!(ffi::rocksdb_destroy_db(opts.inner, cpath.as_ptr(),));
         }
@@ -757,7 +768,7 @@ impl DB {
     }
 
     pub fn repair<P: AsRef<Path>>(opts: Options, path: P) -> Result<(), Error> {
-        let cpath = CString::new(path.as_ref().to_string_lossy().as_bytes()).unwrap();
+        let cpath = to_cpath(path)?;
         unsafe {
             ffi_try!(ffi::rocksdb_repair_db(opts.inner, cpath.as_ptr(),));
         }
@@ -1403,6 +1414,15 @@ impl DBVector {
     }
 }
 
+fn to_cpath<P: AsRef<Path>>(path: P) -> Result<CString, Error> {
+    match CString::new(path.as_ref().to_string_lossy().as_bytes()) {
+        Ok(c) => Ok(c),
+        Err(_) => Err(Error::new(
+            "Failed to convert path to CString when opening DB.".to_owned(),
+        )),
+    }
+}
+
 #[test]
 fn test_db_vector() {
     use std::mem;
@@ -1433,6 +1453,7 @@ fn external() {
 #[test]
 fn errors_do_stuff() {
     let path = "_rust_rocksdb_error";
+    {
         let _db = DB::open_default(path).unwrap();
         let opts = Options::default();
         // The DB will still be open when we try to destroy it and the lock should fail.
@@ -1444,6 +1465,10 @@ fn errors_do_stuff() {
             }
             Ok(_) => panic!("should fail"),
         }
+    }
+    let opts = Options::default();
+    let result = DB::destroy(&opts, path);
+    assert!(result.is_ok());
 }
 
 #[test]
@@ -1570,4 +1595,5 @@ fn set_option_test() {
         ];
         db.set_options(&multiple_options).unwrap();
     }
+    assert!(DB::destroy(&Options::default(), path).is_ok());
 }

src/lib.rs

@@ -18,9 +18,11 @@
 //! # Examples
 //!
 //! ```
-//!  use rocksdb::DB;
+//! use rocksdb::{DB, Options};
 //! // NB: db is automatically closed at end of lifetime
-//!  let db = DB::open_default("path/for/rocksdb/storage").unwrap();
+//! let path = "_path_for_rocksdb_storage";
+//! {
+//!    let db = DB::open_default(path).unwrap();
 //!    db.put(b"my key", b"my value");
 //!    match db.get(b"my key") {
 //!        Ok(Some(value)) => println!("retrieved value {}", value.to_utf8().unwrap()),
@@ -28,12 +30,16 @@
 //!        Err(e) => println!("operational problem encountered: {}", e),
 //!    }
 //!    db.delete(b"my key").unwrap();
+//! }
+//! let _ = DB::destroy(&Options::default(), path);
 //! ```
 //!
 //! Opening a database and a single column family with custom options:
 //!
 //! ```
 //! use rocksdb::{DB, ColumnFamilyDescriptor, Options};
+//!
+//! let path = "_path_for_rocksdb_storage_with_cfs";
 //! let mut cf_opts = Options::default();
 //! cf_opts.set_max_write_buffer_number(16);
 //! let cf = ColumnFamilyDescriptor::new("cf1", cf_opts);
@@ -41,8 +47,10 @@
 //! let mut db_opts = Options::default();
 //! db_opts.create_missing_column_families(true);
 //! db_opts.create_if_missing(true);
-//!
+//! {
-//! let db = DB::open_cf_descriptors(&db_opts, "path/for/rocksdb/storage_with_cfs", vec![cf]).unwrap();
+//!     let db = DB::open_cf_descriptors(&db_opts, path, vec![cf]).unwrap();
+//! }
+//! let _ = DB::destroy(&db_opts, path);
 //! ```
 //!
 
@@ -211,10 +219,11 @@ pub struct Options {
 /// Making an unsafe write of a batch:
 ///
 /// ```
-/// use rocksdb::{DB, WriteBatch, WriteOptions};
+/// use rocksdb::{DB, Options, WriteBatch, WriteOptions};
-///
-/// let db = DB::open_default("path/for/rocksdb/storageY").unwrap();
 ///
+/// let path = "_path_for_rocksdb_storageY";
+/// {
+///     let db = DB::open_default(path).unwrap();
 ///     let mut batch = WriteBatch::default();
 ///     batch.put(b"my key", b"my value");
 ///     batch.put(b"key2", b"value2");
@@ -225,6 +234,8 @@ pub struct Options {
 ///     write_options.disable_wal(true);
 ///
 ///     db.write_opt(batch, &write_options);
+/// }
+/// let _ = DB::destroy(&Options::default(), path);
 /// ```
 pub struct WriteOptions {
     inner: *mut ffi::rocksdb_writeoptions_t,

src/merge_operator.rs

@@ -38,10 +38,11 @@
 //! }
 //!
 //! fn main() {
-//!    let path = "path/to/rocksdb";
+//!    let path = "_rust_path_to_rocksdb";
 //!    let mut opts = Options::default();
 //!    opts.create_if_missing(true);
 //!    opts.set_merge_operator("test operator", concat_merge, None);
+//!    {
 //!        let db = DB::open(&opts, path).unwrap();
 //!         let p = db.put(b"k1", b"a");
 //!         db.merge(b"k1", b"b");
@@ -51,6 +52,8 @@
 //!         let r = db.get(b"k1");
 //!         assert!(r.unwrap().unwrap().to_utf8().unwrap() == "abcdefg");
 //!    }
+//!    let _ = DB::destroy(&opts, path);
+//! }
 //! ```
 
 use libc::{self, c_char, c_int, c_void, size_t};