arrow_buffer/lib.rs
1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: See the NOTICE file distributed with this work for additional information regarding copyright ownership
3// SPDX-FileContributor: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements
4
5//! Low-level buffer abstractions for [Apache Arrow Rust](https://docs.rs/arrow)
6//!
7//! # Byte Storage abstractions
8//! - [`MutableBuffer`]: Raw memory buffer that can be mutated and grown
9//! - [`Buffer`]: Immutable buffer that is shared across threads
10//!
11//! # Typed Abstractions
12//!
13//! There are also several wrappers over [`Buffer`] with methods for
14//! easier manipulation:
15//!
16//! - [`BooleanBuffer`][]: Bitmasks (buffer of packed bits)
17//! - [`NullBuffer`][]: Arrow null (validity) bitmaps ([`BooleanBuffer`] with extra utilities)
18//! - [`ScalarBuffer<T>`][]: Typed buffer for primitive types (e.g., `i32`, `f64`)
19//! - [`OffsetBuffer<O>`][]: Offsets used in variable-length types (e.g., strings, lists)
20//! - [`RunEndBuffer<E>`][]: Run-ends used in run-encoded data
21//!
22//! # Platform Support
23//!
24//! Only little-endian platforms are officially supported and tested in CI.
25//! Big-endian platforms are not tested in CI and may not work correctly.
26//! Fixes for big-endian platforms are welcome and handled on a best-effort basis,
27//! but compatibility is not guaranteed.
28
29#![doc(
30 html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
31 html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
32)]
33#![cfg_attr(docsrs, feature(doc_cfg))]
34#![warn(missing_docs)]
35
36pub mod alloc;
37pub mod buffer;
38pub use buffer::*;
39
40pub mod builder;
41pub use builder::*;
42
43mod error;
44pub use error::{OverflowError, SliceOutOfBoundsError};
45
46mod bigint;
47pub use bigint::i256;
48
49mod divisor;
50pub use divisor::*;
51
52mod bytes;
53
54mod native;
55pub use native::*;
56
57mod util;
58pub use util::*;
59
60mod interval;
61pub use interval::*;
62
63mod arith;
64
65#[cfg(feature = "pool")]
66mod pool;
67#[cfg(feature = "pool")]
68pub use pool::*;