1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors
//! A Vortex encoding that mirrors Arrow's [8-bit Boolean canonical extension type][spec].
//!
//! Each element is stored as a single byte. The zero byte represents `false` and any
//! non-zero byte represents `true`, matching the truthy semantics of the Arrow spec. This
//! trades 8x the storage of the bit-packed `Bool` layout for cheaper per-byte access —
//! useful when data arrives from a C ABI or other source that already emits byte-wide
//! booleans. On execution the array materializes into the standard bit-packed
//! [`BoolArray`][vortex_array::arrays::BoolArray].
//!
//! # Examples
//!
//! Any non-zero byte in the backing buffer is treated as `true` when the array executes
//! to a canonical [`BoolArray`][vortex_array::arrays::BoolArray]:
//!
//! ```
//! # use vortex_array::{IntoArray, LEGACY_SESSION, VortexSessionExecute};
//! # use vortex_array::arrays::BoolArray;
//! # use vortex_array::arrays::bool::BoolArrayExt;
//! # use vortex_array::buffer::BufferHandle;
//! # use vortex_array::validity::Validity;
//! # use vortex_buffer::ByteBuffer;
//! # use vortex_bytebool::ByteBool;
//! # use vortex_error::VortexResult;
//! # fn main() -> VortexResult<()> {
//! # let mut ctx = LEGACY_SESSION.create_execution_ctx();
//! let handle = BufferHandle::new_host(ByteBuffer::from(vec![0u8, 1, 42, 0]));
//! let array = ByteBool::new(handle, Validity::NonNullable);
//!
//! let bits = array.into_array().execute::<BoolArray>(&mut ctx)?.to_bit_buffer();
//! assert!(!bits.value(0));
//! assert!(bits.value(1));
//! assert!(bits.value(2)); // byte 42 is truthy
//! assert!(!bits.value(3));
//! # Ok(())
//! # }
//! ```
//!
//! [spec]: https://arrow.apache.org/docs/format/CanonicalExtensions.html#bit-boolean
pub use *;