pub struct ArrayDataBuilder { /* private fields */ }
Expand description
Builder for ArrayData
type
Implementations§
Source§impl ArrayDataBuilder
impl ArrayDataBuilder
Sourcepub const fn new(data_type: DataType) -> ArrayDataBuilder
pub const fn new(data_type: DataType) -> ArrayDataBuilder
Creates a new array data builder
Sourcepub fn data_type(self, data_type: DataType) -> ArrayDataBuilder
pub fn data_type(self, data_type: DataType) -> ArrayDataBuilder
Creates a new array data builder from an existing one, changing the data type
Sourcepub const fn len(self, n: usize) -> ArrayDataBuilder
pub const fn len(self, n: usize) -> ArrayDataBuilder
Sets the length of the ArrayData
Sourcepub fn nulls(self, nulls: Option<NullBuffer>) -> ArrayDataBuilder
pub fn nulls(self, nulls: Option<NullBuffer>) -> ArrayDataBuilder
Sets the null buffer of the ArrayData
Sourcepub fn null_count(self, null_count: usize) -> ArrayDataBuilder
pub fn null_count(self, null_count: usize) -> ArrayDataBuilder
Sets the null count of the ArrayData
Sourcepub fn null_bit_buffer(self, buf: Option<Buffer>) -> ArrayDataBuilder
pub fn null_bit_buffer(self, buf: Option<Buffer>) -> ArrayDataBuilder
Sets the null_bit_buffer
of the ArrayData
Sourcepub const fn offset(self, n: usize) -> ArrayDataBuilder
pub const fn offset(self, n: usize) -> ArrayDataBuilder
Sets the offset of the ArrayData
Sourcepub fn add_buffer(self, b: Buffer) -> ArrayDataBuilder
pub fn add_buffer(self, b: Buffer) -> ArrayDataBuilder
Adds a single buffer to the ArrayData’s buffers
Sourcepub fn add_buffers<I>(self, bs: I) -> ArrayDataBuilderwhere
I: IntoIterator<Item = Buffer>,
pub fn add_buffers<I>(self, bs: I) -> ArrayDataBuilderwhere
I: IntoIterator<Item = Buffer>,
Adds multiple buffers to the ArrayData’s buffers
Sourcepub fn child_data(self, v: Vec<ArrayData>) -> ArrayDataBuilder
pub fn child_data(self, v: Vec<ArrayData>) -> ArrayDataBuilder
Sets the child data of the ArrayData
Sourcepub fn add_child_data(self, r: ArrayData) -> ArrayDataBuilder
pub fn add_child_data(self, r: ArrayData) -> ArrayDataBuilder
Adds a single child data to the ArrayData’s child data
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.
Trait Implementations§
Source§impl Debug for ArrayDataBuilder
impl Debug for ArrayDataBuilder
Source§impl From<ArrayData> for ArrayDataBuilder
impl From<ArrayData> for ArrayDataBuilder
Source§fn from(d: ArrayData) -> ArrayDataBuilder
fn from(d: ArrayData) -> ArrayDataBuilder
Auto Trait Implementations§
impl Freeze for ArrayDataBuilder
impl RefUnwindSafe for ArrayDataBuilder
impl Send for ArrayDataBuilder
impl Sync for ArrayDataBuilder
impl Unpin for ArrayDataBuilder
impl UnwindSafe for ArrayDataBuilder
Blanket Implementations§
Source§impl<T> AlignerFor<1> for T
impl<T> AlignerFor<1> for T
Source§impl<T> AlignerFor<1024> for T
impl<T> AlignerFor<1024> for T
Source§type Aligner = AlignTo1024<T>
type Aligner = AlignTo1024<T>
AlignTo*
type which aligns Self
to ALIGNMENT
.Source§impl<T> AlignerFor<128> for T
impl<T> AlignerFor<128> for T
Source§type Aligner = AlignTo128<T>
type Aligner = AlignTo128<T>
AlignTo*
type which aligns Self
to ALIGNMENT
.Source§impl<T> AlignerFor<16> for T
impl<T> AlignerFor<16> for T
Source§impl<T> AlignerFor<16384> for T
impl<T> AlignerFor<16384> for T
Source§type Aligner = AlignTo16384<T>
type Aligner = AlignTo16384<T>
AlignTo*
type which aligns Self
to ALIGNMENT
.Source§impl<T> AlignerFor<2> for T
impl<T> AlignerFor<2> for T
Source§impl<T> AlignerFor<2048> for T
impl<T> AlignerFor<2048> for T
Source§type Aligner = AlignTo2048<T>
type Aligner = AlignTo2048<T>
AlignTo*
type which aligns Self
to ALIGNMENT
.Source§impl<T> AlignerFor<256> for T
impl<T> AlignerFor<256> for T
Source§type Aligner = AlignTo256<T>
type Aligner = AlignTo256<T>
AlignTo*
type which aligns Self
to ALIGNMENT
.Source§impl<T> AlignerFor<32> for T
impl<T> AlignerFor<32> for T
Source§impl<T> AlignerFor<32768> for T
impl<T> AlignerFor<32768> for T
Source§type Aligner = AlignTo32768<T>
type Aligner = AlignTo32768<T>
AlignTo*
type which aligns Self
to ALIGNMENT
.Source§impl<T> AlignerFor<4> for T
impl<T> AlignerFor<4> for T
Source§impl<T> AlignerFor<4096> for T
impl<T> AlignerFor<4096> for T
Source§type Aligner = AlignTo4096<T>
type Aligner = AlignTo4096<T>
AlignTo*
type which aligns Self
to ALIGNMENT
.Source§impl<T> AlignerFor<512> for T
impl<T> AlignerFor<512> for T
Source§type Aligner = AlignTo512<T>
type Aligner = AlignTo512<T>
AlignTo*
type which aligns Self
to ALIGNMENT
.Source§impl<T> AlignerFor<64> for T
impl<T> AlignerFor<64> for T
Source§impl<T> AlignerFor<8> for T
impl<T> AlignerFor<8> for T
Source§impl<T> AlignerFor<8192> for T
impl<T> AlignerFor<8192> for T
Source§type Aligner = AlignTo8192<T>
type Aligner = AlignTo8192<T>
AlignTo*
type which aligns Self
to ALIGNMENT
.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<S> ROExtAcc for S
impl<S> ROExtAcc for S
Source§fn f_get<F>(&self, offset: FieldOffset<S, F, Aligned>) -> &F
fn f_get<F>(&self, offset: FieldOffset<S, F, Aligned>) -> &F
offset
. Read moreSource§fn f_get_mut<F>(&mut self, offset: FieldOffset<S, F, Aligned>) -> &mut F
fn f_get_mut<F>(&mut self, offset: FieldOffset<S, F, Aligned>) -> &mut F
offset
. Read moreSource§fn f_get_ptr<F, A>(&self, offset: FieldOffset<S, F, A>) -> *const F
fn f_get_ptr<F, A>(&self, offset: FieldOffset<S, F, A>) -> *const F
offset
. Read moreSource§fn f_get_mut_ptr<F, A>(&mut self, offset: FieldOffset<S, F, A>) -> *mut F
fn f_get_mut_ptr<F, A>(&mut self, offset: FieldOffset<S, F, A>) -> *mut F
offset
. Read moreSource§impl<S> ROExtOps<Aligned> for S
impl<S> ROExtOps<Aligned> for S
Source§fn f_replace<F>(&mut self, offset: FieldOffset<S, F, Aligned>, value: F) -> F
fn f_replace<F>(&mut self, offset: FieldOffset<S, F, Aligned>, value: F) -> F
offset
) with value
,
returning the previous value of the field. Read moreSource§fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Aligned>) -> Fwhere
F: Copy,
fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Aligned>) -> Fwhere
F: Copy,
Source§impl<S> ROExtOps<Unaligned> for S
impl<S> ROExtOps<Unaligned> for S
Source§fn f_replace<F>(&mut self, offset: FieldOffset<S, F, Unaligned>, value: F) -> F
fn f_replace<F>(&mut self, offset: FieldOffset<S, F, Unaligned>, value: F) -> F
offset
) with value
,
returning the previous value of the field. Read moreSource§fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Unaligned>) -> Fwhere
F: Copy,
fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Unaligned>) -> Fwhere
F: Copy,
Source§impl<T> SelfOps for Twhere
T: ?Sized,
impl<T> SelfOps for Twhere
T: ?Sized,
Source§fn piped<F, U>(self, f: F) -> U
fn piped<F, U>(self, f: F) -> U
Source§fn piped_ref<'a, F, U>(&'a self, f: F) -> Uwhere
F: FnOnce(&'a Self) -> U,
fn piped_ref<'a, F, U>(&'a self, f: F) -> Uwhere
F: FnOnce(&'a Self) -> U,
piped
except that the function takes &Self
Useful for functions that take &Self
instead of Self
. Read moreSource§fn piped_mut<'a, F, U>(&'a mut self, f: F) -> Uwhere
F: FnOnce(&'a mut Self) -> U,
fn piped_mut<'a, F, U>(&'a mut self, f: F) -> Uwhere
F: FnOnce(&'a mut Self) -> U,
piped
, except that the function takes &mut Self
.
Useful for functions that take &mut Self
instead of Self
.Source§fn mutated<F>(self, f: F) -> Self
fn mutated<F>(self, f: F) -> Self
Source§fn observe<F>(self, f: F) -> Self
fn observe<F>(self, f: F) -> Self
Source§fn as_ref_<T>(&self) -> &T
fn as_ref_<T>(&self) -> &T
AsRef
,
using the turbofish .as_ref_::<_>()
syntax. Read more