arrow2/io/ipc/read/
mod.rs

1//! APIs to read Arrow's IPC format.
2//!
3//! The two important structs here are the [`FileReader`](reader::FileReader),
4//! which provides arbitrary access to any of its messages, and the
5//! [`StreamReader`](stream::StreamReader), which only supports reading
6//! data in the order it was written in.
7use ahash::AHashMap;
8
9use crate::array::Array;
10
11mod array;
12mod common;
13mod deserialize;
14mod error;
15pub(crate) mod file;
16mod read_basic;
17mod reader;
18mod schema;
19mod stream;
20
21pub use error::OutOfSpecKind;
22
23#[cfg(feature = "io_ipc_read_async")]
24#[cfg_attr(docsrs, doc(cfg(feature = "io_ipc_read_async")))]
25pub mod stream_async;
26
27#[cfg(feature = "io_ipc_read_async")]
28#[cfg_attr(docsrs, doc(cfg(feature = "io_ipc_read_async")))]
29pub mod file_async;
30
31pub(crate) use common::first_dict_field;
32#[cfg(feature = "io_flight")]
33pub(crate) use common::{read_dictionary, read_record_batch};
34pub use file::{read_batch, read_file_dictionaries, read_file_metadata, FileMetadata};
35pub use reader::FileReader;
36pub use schema::deserialize_schema;
37pub use stream::{read_stream_metadata, StreamMetadata, StreamReader, StreamState};
38
39/// how dictionaries are tracked in this crate
40pub type Dictionaries = AHashMap<i64, Box<dyn Array>>;
41
42pub(crate) type Node<'a> = arrow_format::ipc::FieldNodeRef<'a>;
43pub(crate) type IpcBuffer<'a> = arrow_format::ipc::BufferRef<'a>;
44pub(crate) type Compression<'a> = arrow_format::ipc::BodyCompressionRef<'a>;
45pub(crate) type Version = arrow_format::ipc::MetadataVersion;