Docstrings for public functions, structs, enums

src/arrow1/reader.rs

@@ -5,6 +5,8 @@ use parquet::file::reader::{FileReader, SerializedFileReader};
 use parquet::file::serialized_reader::SliceableCursor;
 use std::sync::Arc;
 
+/// Internal function to read a buffer with Parquet data into a buffer with Arrow IPC Stream data
+/// using the arrow and parquet crates
 pub fn read_parquet(parquet_file: &[u8]) -> Result<Vec<u8>, ParquetError> {
     // Create Parquet reader
     let sliceable_cursor = SliceableCursor::new(Arc::new(parquet_file.to_vec()));

src/arrow1/wasm.rs

@@ -2,6 +2,8 @@ use crate::utils::copy_vec_to_uint8_array;
 use js_sys::Uint8Array;
 use wasm_bindgen::prelude::*;
 
+/// Read a Parquet file into a buffer of Arrow data in IPC Stream format, using the arrow and
+/// parquet Rust crates.
 #[wasm_bindgen(js_name = readParquet)]
 pub fn read_parquet(parquet_file: &[u8]) -> Result<Uint8Array, JsValue> {
     match crate::arrow1::reader::read_parquet(parquet_file) {
@@ -10,6 +12,9 @@ pub fn read_parquet(parquet_file: &[u8]) -> Result<Uint8Array, JsValue> {
     }
 }
 
+/// Write a Parquet file from a buffer of Arrow data in IPC Stream format, using the arrow and
+/// parquet Rust crates. Requires a writer_properties argument that can be built from
+/// WriterPropertiesBuilder.
 #[wasm_bindgen(js_name = writeParquet)]
 pub fn write_parquet(
     arrow_file: &[u8],

src/arrow1/writer.rs

@@ -4,6 +4,8 @@ use parquet::errors::ParquetError;
 use parquet::file::writer::InMemoryWriteableCursor;
 use std::io::Cursor;
 
+/// Internal function to write a buffer of data in Arrow IPC Stream format to a Parquet file using
+/// the arrow and parquet crates
 pub fn write_parquet(
     arrow_file: &[u8],
     writer_properties: crate::arrow1::writer_properties::WriterProperties,

src/arrow2/reader.rs

@@ -4,6 +4,8 @@ use arrow2::io::ipc::write::{StreamWriter as IPCStreamWriter, WriteOptions as IP
 use arrow2::io::parquet::read::FileReader as ParquetFileReader;
 use std::io::Cursor;
 
+/// Internal function to read a buffer with Parquet data into a buffer with Arrow IPC Stream data
+/// using the arrow2 and parquet2 crates
 pub fn read_parquet(parquet_file: &[u8]) -> Result<Vec<u8>, ArrowError> {
     // Create Parquet reader
     let input_file = Cursor::new(parquet_file);

src/arrow2/wasm.rs

@@ -2,6 +2,8 @@ use crate::utils::copy_vec_to_uint8_array;
 use js_sys::Uint8Array;
 use wasm_bindgen::prelude::*;
 
+/// Read a Parquet file into a buffer of Arrow data in IPC Stream format, using the arrow2 and
+/// parquet2 Rust crates.
 #[wasm_bindgen(js_name = readParquet2)]
 pub fn read_parquet2(parquet_file: &[u8]) -> Result<Uint8Array, JsValue> {
     match crate::arrow2::reader::read_parquet(parquet_file) {
@@ -10,6 +12,9 @@ pub fn read_parquet2(parquet_file: &[u8]) -> Result<Uint8Array, JsValue> {
     }
 }
 
+/// Write a Parquet file from a buffer of Arrow data in IPC **File** format, using the arrow and
+/// parquet Rust crates. Requires a writer_properties argument that can be built from
+/// WriterPropertiesBuilder.
 #[wasm_bindgen(js_name = writeParquet2)]
 pub fn write_parquet2(
     arrow_file: &[u8],

src/arrow2/writer.rs

@@ -3,6 +3,8 @@ use arrow2::io::ipc::read::{read_file_metadata, FileReader as IPCFileReader};
 use arrow2::io::parquet::write::{FileWriter as ParquetFileWriter, RowGroupIterator};
 use std::io::Cursor;
 
+/// Internal function to write a buffer of data in Arrow IPC File format to a Parquet file using
+/// the arrow2 and parquet2 crates
 pub fn write_parquet(
     arrow_file: &[u8],
     writer_properties: crate::arrow2::writer_properties::WriterProperties,

src/arrow2/writer_properties.rs

@@ -44,6 +44,7 @@ impl WriterVersion {
     }
 }
 
+/// Immutable struct to hold writing configuration for writeParquet2
 #[wasm_bindgen]
 pub struct WriterProperties {
     write_options: arrow2::io::parquet::write::WriteOptions,
@@ -60,6 +61,7 @@ impl WriterProperties {
     }
 }
 
+/// Builder to create a writing configuration for writeParquet2
 #[wasm_bindgen]
 pub struct WriterPropertiesBuilder {
     write_options: arrow2::io::parquet::write::WriteOptions,

src/common/writer_properties.rs

@@ -79,6 +79,7 @@ pub enum Encoding {
     BYTE_STREAM_SPLIT,
 }
 
+/// The Parquet version to use when writing
 #[allow(non_camel_case_types)]
 #[wasm_bindgen]
 pub enum WriterVersion {