Struct arrow::array::ArrayData[−][src]

pub struct ArrayData { /* fields omitted */ }

Expand description

An generic representation of Arrow array data which encapsulates common attributes and operations for Arrow array. Specific operations for different arrays types (e.g., primitive, list, struct) are implemented in Array.

Implementations

[src]

impl ArrayData

[src]

pub unsafe fn new_unchecked(
 data_type: DataType,
 len: usize,
 null_count: Option<usize>,
 null_bit_buffer: Option<Buffer>,
 offset: usize,
 buffers: Vec<Buffer>,
 child_data: Vec<ArrayData>
) -> Self

Create a new ArrayData instance;

If null_count is not specified, the number of nulls in null_bit_buffer is calculated

Safety

The input values must form a valid Arrow array for data_type, or undefined behavior can results.

Note: This is a low level API and most users of the arrow crate should create arrays using the methods in the array module.

[src]

pub fn try_new(
 data_type: DataType,
 len: usize,
 null_count: Option<usize>,
 null_bit_buffer: Option<Buffer>,
 offset: usize,
 buffers: Vec<Buffer>,
 child_data: Vec<ArrayData>
) -> Result<Self>

Create a new ArrayData, validating that the provided buffers form a valid Arrow array of the specified data type.

If null_count is not specified, the number of nulls in null_bit_buffer is calculated

Note: This is a low level API and most users of the arrow crate should create arrays using the methods in the array module.

[src]

pub const fn builder(data_type: DataType) -> ArrayDataBuilder

Returns a builder to construct a ArrayData instance.

[src]

pub const fn data_type(&self) -> &DataType

Returns a reference to the data type of this array data

[src]

pub fn buffers(&self) -> &[Buffer ]

Returns a slice of buffers for this array data

[src]

pub fn child_data(&self) -> &[ArrayData ]

Returns a slice of children data arrays

[src]

pub fn is_null(&self, i: usize) -> bool

Returns whether the element at index i is null

[src]

pub const fn null_bitmap(&self) -> &Option<Bitmap>

Returns a reference to the null bitmap of this array data

[src]

pub fn null_buffer(&self) -> Option<&Buffer>

Returns a reference to the null buffer of this array data.

[src]

pub fn is_valid(&self, i: usize) -> bool

Returns whether the element at index i is not null

[src]

pub const fn len(&self) -> usize

Returns the length (i.e., number of elements) of this array

[src]

pub const fn is_empty(&self) -> bool

[src]

pub const fn offset(&self) -> usize

Returns the offset of this array

[src]

pub const fn null_count(&self) -> usize

Returns the total number of nulls in this array

[src]

pub fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied by the buffers owned by this ArrayData.

[src]

pub fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this ArrayData.

[src]

pub fn slice(&self, offset: usize, length: usize) -> ArrayData

Creates a zero-copy slice of itself. This creates a new ArrayData with a different offset, len and a shifted null bitmap.

Panics

Panics if offset + length > self.len().

[src]

pub fn new_empty(data_type: &DataType) -> Self

Returns a new empty ArrayData valid for data_type.

[src]

pub fn validate(&self) -> Result<()>

“cheap” validation of an ArrayData. Ensures buffers are sufficiently sized to store len + offset total elements of data_type and performs other inexpensive consistency checks.

This check is “cheap” in the sense that it does not validate the contents of the buffers (e.g. that all offsets for UTF8 arrays are within the bounds of the values buffer).

See [validate_full] to validate fully the offset content and the validitiy of utf8 data

[src]