quack-rs 0.16.0

Production-grade Rust SDK for building DuckDB loadable extensions
Documentation 
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
50
51
52
53
54
55
56
57
58
59
60

// SPDX-License-Identifier: MIT
// Copyright 2026 Tom F. <https://github.com/tomtom215/>
// My way of giving something small back to the open source community
// and encouraging more Rust development!

//! Safe helpers for reading from and writing to `DuckDB` data vectors.
//!
//! `DuckDB` represents columnar data as "vectors" — arrays of typed values
//! with an associated validity bitmap for NULL tracking. This module provides
//! safe wrappers that eliminate the raw pointer arithmetic and undocumented
//! struct layouts that trip up extension authors.
//!
//! # Pitfalls solved by this module
//!
//! - **L4**: `ensure_validity_writable` — [`VectorWriter`] calls this automatically
//!   before any NULL-setting operation.
//! - **L5**: Boolean reading — [`VectorReader`] always reads bytes as `u8 != 0`,
//!   never as `bool`, preventing undefined behaviour.
//! - **P7**: `duckdb_string_t` format — [`string`] handles both the inline (≤12 bytes)
//!   and pointer (>12 bytes) cases.
//! - **Stale child pointers** — [`ListBuilder`] re-fetches the child writer after
//!   every `reserve`, which reallocates the child vector. See
//!   [`list_builder`][mod@list_builder].

pub mod complex;
pub mod list_builder;
pub mod reader;
pub mod string;
pub mod struct_reader;
pub mod struct_writer;
pub mod uuid;
pub mod validity;
pub mod writer;

pub use list_builder::{ListBuilder, MAX_LIST_CHILD_CAPACITY};
pub use reader::VectorReader;
pub use string::{read_duck_blob, read_duck_string, DuckStringView};
pub use struct_reader::StructReader;
pub use struct_writer::StructWriter;
pub use uuid::{uuid_from_storage, uuid_to_storage};
pub use validity::ValidityBitmap;
pub use writer::VectorWriter;

/// Returns the default vector size used by `DuckDB` (typically 2048).
#[mutants::skip]
pub fn vector_size() -> u64 {
    // SAFETY: this call takes no arguments and reads a compile-time constant.
    unsafe { libduckdb_sys::duckdb_vector_size() as u64 }
}

/// Returns the logical type of a vector.
///
/// # Safety
/// `vector` must be a valid `duckdb_vector`.
pub unsafe fn vector_get_column_type(
    vector: libduckdb_sys::duckdb_vector,
) -> crate::types::LogicalType {
    let raw = unsafe { libduckdb_sys::duckdb_vector_get_column_type(vector) };
    unsafe { crate::types::LogicalType::from_raw(raw) }
}