Skip to main content

OwnedVector

Struct OwnedVector 

Source
pub struct OwnedVector { /* private fields */ }
Expand description

A flat duckdb_vector this crate allocated, destroyed on drop.

DuckDB normally hands an extension the vectors it should read or write. This is for the cases where an extension needs one of its own: a destination for copy_selected, a staging buffer, or a vector to hand to Appender::append_chunk.

Requires duckdb-1-5: duckdb_create_vector sits in the unstable region of the C API struct.

Implementations§

Source§

impl OwnedVector

Source

pub fn new( logical_type: &LogicalType, capacity: usize, ) -> Result<Self, ExtensionError>

Allocates a flat vector of logical_type with room for capacity rows.

§Errors

Returns an error, before anything is allocated, if capacity — or capacity times the sizes of the ARRAY types nested in logical_type — exceeds MAX_CAPACITY. Also returns an error if DuckDB refuses to allocate the vector: an INVALID or ANY type, or an allocation that fails.

The capacity check is not optional hygiene. DuckDB sizes the buffer as capacity * element_size with an unchecked multiply (VectorBuffer::CreateStandardVector, vector_buffer.cpp), and an ARRAY child as capacity * array_size, also unchecked. A capacity that wraps gets a small buffer and a success return, and writes inside the capacity this function reported would then overflow the heap.

Source

pub const fn as_raw(&self) -> duckdb_vector

Returns the raw handle. Do not destroy it — this value still owns it.

Source

pub const fn into_raw(self) -> duckdb_vector

Relinquishes ownership, returning the raw handle.

The caller becomes responsible for duckdb_destroy_vector.

Trait Implementations§

Source§

impl Debug for OwnedVector

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Drop for OwnedVector

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