Struct DataChunkHandle 

pub struct DataChunkHandle { /* private fields */ }

An owned-or-borrowed DuckDB data chunk. A DuckDB data chunk: a batch of rows laid out column-wise, one VectorRef/ VectorMut per column.

Either owned by this handle (allocated via DataChunkHandle::new and destroyed on drop) or borrowed from a DuckDB callback frame (via a crate- internal constructor), in which case DuckDB owns the chunk itself and it must not be destroyed out from under it.

This is a separate type from the crate’s internal, read-only raw::data_chunk::DataChunk — that type’s Drop unconditionally destroys the chunk and its next_row destroys-and-nulls on exhaustion, both of which would double-free a chunk DuckDB owns.

Implementations

impl DataChunkHandle

pub fn new(types: &[LogicalType]) -> Result<Self>

Allocates a new data chunk with the given column types.

Errors

Returns an error if DuckDB fails to allocate the chunk.

pub fn vector(&self, idx: usize) -> Result<VectorRef<'_>>

Returns a read-only view of column idx.

Errors

Returns an error if idx is out of range.

pub fn vector_mut(&mut self, idx: usize) -> Result<VectorMut<'_>>

Returns an exclusive, writable view of column idx.

Errors

Returns an error if idx is out of range.

pub fn vectors_mut(&mut self) -> Result<Vec<VectorMut<'_>>>

Returns a writable view of every column, in column order.

The views are disjoint by construction (distinct column indices), so they may be held simultaneously despite each being individually exclusive.

Errors

Returns an error if a column vector cannot be obtained.

pub fn len(&self) -> usize

The number of rows currently in this chunk.

pub fn is_empty(&self) -> bool

Returns true if this chunk has no rows.

pub fn num_columns(&self) -> usize

The number of columns in this chunk.

pub fn set_len(&mut self, n: usize) -> Result<()>

Sets the number of valid rows in this chunk.

Errors

Returns an error if n exceeds DataChunkHandle::capacity.

pub fn capacity(&self) -> usize

The maximum number of rows this chunk can hold — DuckDB’s build-time vector size, not a fixed constant. Never hardcode a row-count limit; always read it from here.

Trait Implementations

impl Drop for DataChunkHandle

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.