arrow_ipc/lib.rs
1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements. See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership. The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License. You may obtain a copy of the License at
8//
9// http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied. See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18//! Support for the [Arrow IPC Format]
19//!
20//! [Arrow IPC Format]: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc
21
22#![warn(missing_docs)]
23pub mod convert;
24pub mod reader;
25pub mod writer;
26
27mod compression;
28
29#[allow(clippy::redundant_closure)]
30#[allow(clippy::needless_lifetimes)]
31#[allow(clippy::extra_unused_lifetimes)]
32#[allow(clippy::redundant_static_lifetimes)]
33#[allow(clippy::redundant_field_names)]
34#[allow(non_camel_case_types)]
35#[allow(missing_docs)] // Because this is autogenerated
36pub mod gen;
37
38pub use self::gen::File::*;
39pub use self::gen::Message::*;
40pub use self::gen::Schema::*;
41pub use self::gen::SparseTensor::*;
42pub use self::gen::Tensor::*;
43
44const ARROW_MAGIC: [u8; 6] = [b'A', b'R', b'R', b'O', b'W', b'1'];
45const CONTINUATION_MARKER: [u8; 4] = [0xff; 4];