alamb commented on code in PR #3421:
URL: https://github.com/apache/arrow-rs/pull/3421#discussion_r1059634810
##########
arrow-ipc/src/writer.rs:
##########
@@ -137,6 +137,34 @@ impl Default for IpcWriteOptions {
}
#[derive(Debug, Default)]
+/// Handles low level details of encoding [`Array`] and [`Schema`] into the
+/// [Arrow IPC Format](https://arrow.apache.org/docs/format/IPC.html)
+///
+/// # Example:
+/// ```
+/// # fn run() {
+/// # use std::sync::Arc;
+/// # use arrow_array::UInt64Array;
+/// # use arrow_array::RecordBatch;
+/// # use arrow_ipc::writer::{DictionaryTracker, IpcDataGenerator,
IpcWriteOptions};
+///
+/// // Create a record batch
+/// let batch = RecordBatch::try_from_iter(vec![
+/// ("col2", Arc::new(UInt64Array::from_iter([10, 23, 33])) as _)
+/// ]).unwrap();
+///
+/// // Error of dictionary ids are replaced.
+/// let error_on_replacement = true;
+/// let options = IpcWriteOptions::default();
Review Comment:
This interface is somewhat unfortunate (like there is no state on
IpcDataGenerator and the state is passed in via DictionaryTracker).
While implementing #3389 I hope to provide something that handles all the
encoding state so this interface will remain low level
##########
arrow-ipc/src/lib.rs:
##########
@@ -15,10 +15,7 @@
// specific language governing permissions and limitations
// under the License.
-//! Support for the Arrow IPC format
-
-// TODO: (vcq): Protobuf codegen is not generating Debug impls.
Review Comment:
Drive by cleanup
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
