Struct arrow::array::ArrayDataBuilder
source · pub struct ArrayDataBuilder { /* private fields */ }
Expand description
Builder for ArrayData
type
Implementations§
source§impl ArrayDataBuilder
impl ArrayDataBuilder
pub const fn new(data_type: DataType) -> ArrayDataBuilder
pub fn data_type(self, data_type: DataType) -> ArrayDataBuilder
pub const fn len(self, n: usize) -> ArrayDataBuilder
pub fn nulls(self, nulls: Option<NullBuffer>) -> ArrayDataBuilder
pub fn null_count(self, null_count: usize) -> ArrayDataBuilder
pub fn null_bit_buffer(self, buf: Option<Buffer>) -> ArrayDataBuilder
pub const fn offset(self, n: usize) -> ArrayDataBuilder
pub fn buffers(self, v: Vec<Buffer>) -> ArrayDataBuilder
pub fn add_buffer(self, b: Buffer) -> ArrayDataBuilder
pub fn child_data(self, v: Vec<ArrayData>) -> ArrayDataBuilder
pub fn add_child_data(self, r: ArrayData) -> ArrayDataBuilder
sourcepub unsafe fn build_unchecked(self) -> ArrayData
pub unsafe fn build_unchecked(self) -> ArrayData
Creates an array data, without any validation
§Safety
The same caveats as ArrayData::new_unchecked
apply.
sourcepub fn build(self) -> Result<ArrayData, ArrowError>
pub fn build(self) -> Result<ArrayData, ArrowError>
Creates an array data, validating all inputs
sourcepub fn build_aligned(self) -> Result<ArrayData, ArrowError>
pub fn build_aligned(self) -> Result<ArrayData, ArrowError>
Creates an array data, validating all inputs, and aligning any buffers
Rust requires that arrays are aligned to their corresponding primitive,
see Layout::array
and std::mem::align_of
.
ArrayData
therefore requires that all buffers have at least this alignment,
to allow for slice based APIs. See BufferSpec::FixedWidth
.
As this alignment is architecture specific, and not guaranteed by all arrow implementations, this method is provided to automatically copy buffers to a new correctly aligned allocation when necessary, making it useful when interacting with buffers produced by other systems, e.g. IPC or FFI.
This is unlike [Self::build
] which will instead return an error on encountering
insufficiently aligned buffers.