From bfb6dc40dca830d9868fdfdab4b8e32c1a3ab7f9 Mon Sep 17 00:00:00 2001 From: Jefffrey Date: Sun, 23 Feb 2025 18:47:22 +1100 Subject: [PATCH] doc: fix IPC file reader/writer docs --- arrow-ipc/src/reader.rs | 2 +- arrow-ipc/src/writer.rs | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/arrow-ipc/src/reader.rs b/arrow-ipc/src/reader.rs index ca0d09e2282f..ddda179cbe00 100644 --- a/arrow-ipc/src/reader.rs +++ b/arrow-ipc/src/reader.rs @@ -1062,7 +1062,7 @@ impl FileReaderBuilder { /// For an example creating Arrays without copying using memory mapped (`mmap`) /// files see the [`zero_copy_ipc`] example. /// -/// [IPC Streaming Format]: https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format +/// [IPC File Format]: https://arrow.apache.org/docs/format/Columnar.html#ipc-file-format /// [`zero_copy_ipc`]: https://github.com/apache/arrow-rs/blob/main/arrow/examples/zero_copy_ipc.rs pub struct FileReader { /// File reader that supports reading and seeking diff --git a/arrow-ipc/src/writer.rs b/arrow-ipc/src/writer.rs index 451b7e02c5cc..f5ba6b77a85e 100644 --- a/arrow-ipc/src/writer.rs +++ b/arrow-ipc/src/writer.rs @@ -920,11 +920,11 @@ impl DictionaryTracker { /// # Example /// ``` /// # use arrow_array::record_batch; -/// # use arrow_ipc::writer::StreamWriter; +/// # use arrow_ipc::writer::FileWriter; /// # let mut file = vec![]; // mimic a file for the example /// let batch = record_batch!(("a", Int32, [1, 2, 3])).unwrap(); /// // create a new writer, the schema must be known in advance -/// let mut writer = StreamWriter::try_new(&mut file, &batch.schema()).unwrap(); +/// let mut writer = FileWriter::try_new(&mut file, &batch.schema()).unwrap(); /// // write each batch to the underlying writer /// writer.write(&batch).unwrap(); /// // When all batches are written, call finish to flush all buffers