Auto merge of #108 - Amanieu:pub_rawtable, r=Amanieu

Experimentally expose RawTable under the "raw" feature

Fixes #104

Author: bors

.travis.yml

@@ -13,7 +13,7 @@ matrix:
     - name: "docs"
       env: TARGET=x86_64-unknown-linux-gnu
       script:
-        - cargo -vv doc --features nightly,serde,rayon
+        - cargo -vv doc --features nightly,serde,rayon,raw
         - echo '<meta http-equiv=refresh content=0;url=hashbrown/index.html>' > target/doc/index.html
       deploy:
         provider: pages

Cargo.toml

@@ -41,3 +41,7 @@ default = ["ahash"]
 nightly = []
 rustc-internal-api = []
 rustc-dep-of-std = ["nightly", "core", "compiler_builtins", "alloc", "rustc-internal-api"]
+raw = []
+
+[package.metadata.docs.rs]
+features = ["nightly", "rayon", "serde", "raw"]

README.md

@@ -101,6 +101,7 @@ This crate has the following Cargo features:
 - `nightly`: Enables nightly-only features: `#[may_dangle]`.
 - `serde`: Enables serde serialization support.
 - `rayon`: Enables rayon parallel iterator support.
+- `raw`: Enables access to the experimental and unsafe `RawTable` API.
 
 ## License
 

src/external_trait_impls/rayon/mod.rs

@@ -1,5 +1,4 @@
 mod helpers;
-mod raw;
-
 pub(crate) mod map;
+pub(crate) mod raw;
 pub(crate) mod set;

src/lib.rs

@@ -43,9 +43,26 @@ doc_comment::doctest!("../README.md");
 #[macro_use]
 mod macros;
 
+#[cfg(feature = "raw")]
+/// Experimental and unsafe `RawTable` API. This module is only available if the
+/// `raw` feature is enabled.
+pub mod raw {
+    // The RawTable API is still experimental and is not properly documented yet.
+    #[allow(missing_docs)]
+    #[path = "mod.rs"]
+    mod inner;
+    pub use inner::*;
+
+    #[cfg(feature = "rayon")]
+    pub mod rayon {
+        pub use crate::external_trait_impls::rayon::raw::*;
+    }
+}
+#[cfg(not(feature = "raw"))]
+mod raw;
+
 mod external_trait_impls;
 mod map;
-mod raw;
 #[cfg(feature = "rustc-internal-api")]
 mod rustc_entry;
 mod scopeguard;

src/raw/mod.rs

@@ -959,7 +959,7 @@ impl<T> RawTable<T> {
     /// Converts the table into a raw allocation. The contents of the table
     /// should be dropped using a `RawIter` before freeing the allocation.
     #[inline]
-    pub fn into_alloc(self) -> Option<(NonNull<u8>, Layout)> {
+    pub(crate) fn into_alloc(self) -> Option<(NonNull<u8>, Layout)> {
         let alloc = if self.is_empty_singleton() {
             None
         } else {
@@ -1080,7 +1080,7 @@ impl<T> IntoIterator for RawTable<T> {
 
 /// Iterator over a sub-range of a table. Unlike `RawIter` this iterator does
 /// not track an item count.
-pub struct RawIterRange<T> {
+pub(crate) struct RawIterRange<T> {
     // Mask of full buckets in the current group. Bits are cleared from this
     // mask as each element is processed.
     current_group: BitMask,
@@ -1124,7 +1124,7 @@ impl<T> RawIterRange<T> {
     /// group width.
     #[inline]
     #[cfg(feature = "rayon")]
-    pub fn split(mut self) -> (Self, Option<RawIterRange<T>>) {
+    pub(crate) fn split(mut self) -> (Self, Option<RawIterRange<T>>) {
         unsafe {
             if self.end <= self.next_ctrl {
                 // Nothing to split if the group that we are current processing
@@ -1219,7 +1219,7 @@ impl<T> FusedIterator for RawIterRange<T> {}
 
 /// Iterator which returns a raw pointer to every full bucket in the table.
 pub struct RawIter<T> {
-    pub iter: RawIterRange<T>,
+    pub(crate) iter: RawIterRange<T>,
     items: usize,
 }