Make arrow::array_reader private (#1032)

Author: tustvold

parquet/Cargo.toml

@@ -60,6 +60,8 @@ arrow = { path = "../arrow", version = "7.0.0-SNAPSHOT", default-features = fals
 default = ["arrow", "snap", "brotli", "flate2", "lz4", "zstd", "base64"]
 cli = ["serde_json", "base64", "clap"]
 test_common = []
+# Experimental, unstable functionality primarily used for testing
+experimental = []
 
 [[ bin ]]
 name = "parquet-read"
@@ -79,5 +81,5 @@ harness = false
 
 [[bench]]
 name = "arrow_array_reader"
-required-features = ["test_common"]
+required-features = ["test_common", "experimental"]
 harness = false

parquet/src/arrow/mod.rs

@@ -118,7 +118,7 @@
 //!}
 //! ```
 
-pub mod array_reader;
+experimental_mod!(array_reader);
 pub mod arrow_array_reader;
 pub mod arrow_reader;
 pub mod arrow_writer;

parquet/src/lib.rs

@@ -35,6 +35,22 @@
     clippy::vec_init_then_push
 )]
 
+/// Defines a module with an experimental public API
+///
+/// The module will not be documented, and will only be public if the
+/// experimental feature flag is enabled
+///
+/// Experimental modules have no stability guarantees
+macro_rules! experimental_mod {
+    ($module:ident) => {
+        #[cfg(feature = "experimental")]
+        #[doc(hidden)]
+        pub mod $module;
+        #[cfg(not(feature = "experimental"))]
+        mod $module;
+    };
+}
+
 #[macro_use]
 pub mod errors;
 pub mod basic;