Skip to main content

DataChunk

Struct DataChunk 

Source
pub struct DataChunk(/* private fields */);
Expand description

An owned DuckDB duckdb_data_chunk — a batch of column vectors — that is destroyed on drop.

Obtain one from a query result with DataChunk::from_result, then append it elsewhere with Appender::append_chunk.

Implementations§

Source§

impl DataChunk

Source

pub fn new(data_chunk: duckdb_data_chunk) -> Result<DataChunk>

Takes ownership of a raw duckdb_data_chunk handle.

§Errors

Returns an error if data_chunk is null.

Source

pub fn from_result(result: &DuckResult) -> Option<Result<DataChunk>>

Fetches the next chunk of a query result, or None once the result is exhausted.

Source

pub fn current_row(&self) -> u64

The current row cursor used by next_row.

Source

pub fn row_count(&self) -> u64

The number of rows in the chunk.

Source

pub fn reset(&mut self)

Resets the chunk to empty (row count 0), keeping its allocated capacity so it can be refilled and re-appended.

Source

pub fn next_row(&mut self) -> Option<u64>

Advances the row cursor, returning the next row index, or None at the end (destroying the underlying chunk).

Trait Implementations§

Source§

impl Deref for DataChunk

Source§

type Target = *mut _duckdb_data_chunk

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl DerefMut for DataChunk

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
Source§

impl Drop for DataChunk

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.