Module builders

Module builders 

Source
Expand description

Builders for Vortex arrays.

Every logical type in Vortex has a canonical (uncompressed) in-memory encoding. This module provides pre-allocated builders to construct new canonical arrays.

§Example:

use vortex_array::builders::{builder_with_capacity, ArrayBuilder};
use vortex_dtype::{DType, Nullability};

// Create a new builder for string data.
let mut builder = builder_with_capacity(&DType::Utf8(Nullability::NonNullable), 4);

builder.append_scalar(&"a".into()).unwrap();
builder.append_scalar(&"b".into()).unwrap();
builder.append_scalar(&"c".into()).unwrap();
builder.append_scalar(&"d".into()).unwrap();

let strings = builder.finish();

assert_eq!(strings.scalar_at(0), "a".into());
assert_eq!(strings.scalar_at(1), "b".into());
assert_eq!(strings.scalar_at(2), "c".into());
assert_eq!(strings.scalar_at(3), "d".into());

Structs§

BoolBuilder
DecimalBuilder
The builder for building a DecimalArray.
ExtensionBuilder
The builder for building a ExtensionArray.
FixedSizeListBuilder
The builder for building a FixedSizeListArray.
ListBuilder
The builder for building a ListArray, parametrized by the PType of the offsets buffer.
NullBuilder
The builder for building a NullArray.
PrimitiveBuilder
The builder for building a PrimitiveArray, parametrized by the PType.
StructBuilder
The builder for building a StructArray.
UninitRange
A range of uninitialized values in the primitive builder that can be filled.
VarBinViewBuilder
The builder for building a VarBinViewArray.

Constants§

DEFAULT_BUILDER_CAPACITY
The default capacity for builders.

Traits§

ArrayBuilder

Functions§

builder_with_capacity
Construct a new canonical builder for the given DType.