Publically doc and export

apache · Jan 14, 2025 · cd05188 · cd05188
1 parent 8acb070
commit cd05188
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/parquet/src/lib.rs b/parquet/src/lib.rs
@@ -131,6 +131,9 @@ pub mod data_type;
 pub use self::encodings::{decoding, encoding};
 
 experimental!(#[macro_use] mod util);
+
+pub use util::utf8;
+
 #[cfg(feature = "arrow")]
 pub mod arrow;
 pub mod column;

diff --git a/parquet/src/util/mod.rs b/parquet/src/util/mod.rs
@@ -22,7 +22,7 @@ pub(crate) mod interner;
 
 #[cfg(any(test, feature = "test_common"))]
 pub(crate) mod test_common;
-pub(crate) mod utf8;
+pub mod utf8;
 
 #[cfg(any(test, feature = "test_common"))]
 pub use self::test_common::page_util::{

diff --git a/parquet/src/util/utf8.rs b/parquet/src/util/utf8.rs
@@ -28,6 +28,15 @@ use crate::errors::{Result, ParquetError};
 ///
 /// Returns `Err::General` with a message compatible with [`std::str::from_utf8`] on failure.
 ///
+/// # Example
+/// ```
+/// use parquet::utf8::check_valid_utf8;
+/// assert!(check_valid_utf8(b"hello").is_ok());
+/// assert!(check_valid_utf8(b"hello \xF0\x9F\x98\x8E").is_ok());
+/// // invalid UTF-8
+/// assert!(check_valid_utf8(b"hello \xF0\x9F\x98").is_err());
+/// ```
+///
 /// [`simdutf8`]: https://crates.io/crates/simdutf8
 #[inline(always)]
 pub fn check_valid_utf8(val: &[u8]) -> Result<()> {