Struct GenericByteArray

pub struct GenericByteArray<T>where
    T: ByteArrayType,{
    data_type: DataType,
    value_offsets: OffsetBuffer<<T as ByteArrayType>::Offset>,
    value_data: Buffer,
    nulls: Option<NullBuffer>,
}

Expand description

An array of variable length byte arrays

See StringArray and LargeStringArray for storing utf8 encoded string data

See BinaryArray and LargeBinaryArray for storing arbitrary bytes

§Example: From a Vec

let arr: GenericByteArray<Utf8Type> = vec!["hello", "world", ""].into();
assert_eq!(arr.value_data(), b"helloworld");
assert_eq!(arr.value_offsets(), &[0, 5, 10, 10]);
let values: Vec<_> = arr.iter().collect();
assert_eq!(values, &[Some("hello"), Some("world"), Some("")]);

§Example: From an optional Vec

let arr: GenericByteArray<Utf8Type> = vec![Some("hello"), Some("world"), Some(""), None].into();
assert_eq!(arr.value_data(), b"helloworld");
assert_eq!(arr.value_offsets(), &[0, 5, 10, 10, 10]);
let values: Vec<_> = arr.iter().collect();
assert_eq!(values, &[Some("hello"), Some("world"), Some(""), None]);

§Example: From an iterator of option

let arr: GenericByteArray<Utf8Type> = (0..5).map(|x| (x % 2 == 0).then(|| x.to_string())).collect();
let values: Vec<_> = arr.iter().collect();
assert_eq!(values, &[Some("0"), None, Some("2"), None, Some("4")]);

§Example: Using Builder

let mut builder = GenericByteBuilder::<Utf8Type>::new();
builder.append_value("hello");
builder.append_null();
builder.append_value("world");
let array = builder.finish();
let values: Vec<_> = array.iter().collect();
assert_eq!(values, &[Some("hello"), None, Some("world")]);

Fields§

§data_type: DataType§value_offsets: OffsetBuffer<<T as ByteArrayType>::Offset>§value_data: Buffer§nulls: Option<NullBuffer>

Implementations§

§

impl<OffsetSize> GenericByteArray<GenericBinaryType<OffsetSize>>
where OffsetSize: OffsetSizeTrait,

pub fn from_vec( v: Vec<&[u8]>, ) -> GenericByteArray<GenericBinaryType<OffsetSize>>

Creates a GenericBinaryArray from a vector of byte slices

pub fn from_opt_vec( v: Vec<Option<&[u8]>>, ) -> GenericByteArray<GenericBinaryType<OffsetSize>>

Creates a GenericBinaryArray from a vector of Optional (null) byte slices

pub fn take_iter<'a>( &'a self, indexes: impl Iterator<Item = Option<usize>> + 'a, ) -> impl Iterator<Item = Option<&'a [u8]>>

Returns an iterator that returns the values of array.value(i) for an iterator with each element i

pub unsafe fn take_iter_unchecked<'a>( &'a self, indexes: impl Iterator<Item = Option<usize>> + 'a, ) -> impl Iterator<Item = Option<&'a [u8]>>

Returns an iterator that returns the values of array.value(i) for an iterator with each element i

§Safety

caller must ensure that the indexes in the iterator are less than the array.len()

§

impl<T> GenericByteArray<T>
where T: ByteArrayType,

pub const DATA_TYPE: DataType = T::DATA_TYPE

Data type of the array.

pub fn new( offsets: OffsetBuffer<<T as ByteArrayType>::Offset>, values: Buffer, nulls: Option<NullBuffer>, ) -> GenericByteArray<T>

Create a new GenericByteArray from the provided parts, panicking on failure

§Panics

Panics if GenericByteArray::try_new returns an error

pub fn try_new( offsets: OffsetBuffer<<T as ByteArrayType>::Offset>, values: Buffer, nulls: Option<NullBuffer>, ) -> Result<GenericByteArray<T>, ArrowError>

Create a new GenericByteArray from the provided parts, returning an error on failure

§Errors

offsets.len() - 1 != nulls.len()
Any consecutive pair of offsets does not denote a valid slice of values

pub unsafe fn new_unchecked( offsets: OffsetBuffer<<T as ByteArrayType>::Offset>, values: Buffer, nulls: Option<NullBuffer>, ) -> GenericByteArray<T>

Create a new GenericByteArray from the provided parts, without validation

§Safety

Safe if Self::try_new would not error

pub fn new_null(len: usize) -> GenericByteArray<T>

Create a new GenericByteArray of length len where all values are null

pub fn new_scalar( value: impl AsRef<<T as ByteArrayType>::Native>, ) -> Scalar<GenericByteArray<T>>

Create a new Scalar from v

pub fn new_repeated( value: impl AsRef<<T as ByteArrayType>::Native>, repeat_count: usize, ) -> GenericByteArray<T>

Create a new GenericByteArray where value is repeated repeat_count times.

§Panics

This will panic if value’s length multiplied by repeat_count overflows usize.

pub fn from_iter_values<Ptr, I>(iter: I) -> GenericByteArray<T>
where Ptr: AsRef<<T as ByteArrayType>::Native>, I: IntoIterator<Item = Ptr>,

Creates a GenericByteArray based on an iterator of values without nulls

§Panics

Panics if the iterator has no upper bound on its size hint, or if the total length of the values exceeds T::Offset::MAX

pub fn into_parts( self, ) -> (OffsetBuffer<<T as ByteArrayType>::Offset>, Buffer, Option<NullBuffer>)

Deconstruct this array into its constituent parts

pub fn value_length(&self, i: usize) -> <T as ByteArrayType>::Offset

Returns the length for value at index i.

§Panics

Panics if index i is out of bounds.

pub fn offsets(&self) -> &OffsetBuffer<<T as ByteArrayType>::Offset>

Returns a reference to the offsets of this array

Unlike Self::value_offsets this returns the OffsetBuffer allowing for zero-copy cloning

pub fn values(&self) -> &Buffer

Returns the values of this array

Unlike Self::value_data this returns the Buffer allowing for zero-copy cloning

pub fn value_data(&self) -> &[u8] ⓘ

Returns the raw value data

pub fn is_ascii(&self) -> bool

Returns true if all data within this array is ASCII

pub fn value_offsets(&self) -> &[<T as ByteArrayType>::Offset]

Returns the offset values in the offsets buffer

pub unsafe fn value_unchecked(&self, i: usize) -> &<T as ByteArrayType>::Native

Returns the element at index i

Note: This method does not check for nulls and the value is arbitrary if is_null returns true for the index.

§Safety

Caller is responsible for ensuring that the index is within the bounds of the array

pub fn value(&self, i: usize) -> &<T as ByteArrayType>::Native

Returns the element at index i

Note: This method does not check for nulls and the value is arbitrary (but still well-defined) if is_null returns true for the index.

§Panics

Panics if index i is out of bounds.

pub fn iter(&self) -> ArrayIter<&GenericByteArray<T>> ⓘ

constructs a new iterator

pub fn slice(&self, offset: usize, length: usize) -> GenericByteArray<T>

Returns a zero-copy slice of this array with the indicated offset and length.

§Panics

Panics if offset + length > self.len()

pub fn into_builder(self) -> Result<GenericByteBuilder<T>, GenericByteArray<T>>

Returns GenericByteBuilder of this byte array for mutating its values if the underlying offset and data buffers are not shared by others.

§

impl<OffsetSize> GenericByteArray<GenericStringType<OffsetSize>>
where OffsetSize: OffsetSizeTrait,

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

Returns the number of Unicode Scalar Value in the string at index i.

§Performance

This function has O(n) time complexity where n is the string length. If you can make sure that all chars in the string are in the range U+0x0000 ~ U+0x007F, please use the function value_length which has O(1) time complexity.

pub fn take_iter<'a>( &'a self, indexes: impl Iterator<Item = Option<usize>> + 'a, ) -> impl Iterator<Item = Option<&'a str>>

Returns an iterator that returns the values of array.value(i) for an iterator with each element i

pub unsafe fn take_iter_unchecked<'a>( &'a self, indexes: impl Iterator<Item = Option<usize>> + 'a, ) -> impl Iterator<Item = Option<&'a str>>

Returns an iterator that returns the values of array.value(i) for an iterator with each element i

§Safety

caller must ensure that the indexes in the iterator are less than the array.len()

pub fn try_from_binary( v: GenericByteArray<GenericBinaryType<OffsetSize>>, ) -> Result<GenericByteArray<GenericStringType<OffsetSize>>, ArrowError>

Fallibly creates a GenericStringArray from a GenericBinaryArray returning an error if GenericBinaryArray contains invalid UTF-8 data

Trait Implementations§

§

impl<T> Array for GenericByteArray<T>
where T: ByteArrayType,

SAFETY: Correctly implements the contract of Arrow Arrays

§

fn as_any(&self) -> &(dyn Any + 'static)

Returns the array as Any so that it can be downcasted to a specific implementation. Read more

§

fn to_data(&self) -> ArrayData

Returns the underlying data of this array

§

fn into_data(self) -> ArrayData

Returns the underlying data of this array Read more

§

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array. Read more

§

fn slice(&self, offset: usize, length: usize) -> Arc<dyn Array> ⓘ

Returns a zero-copy slice of this array with the indicated offset and length. Read more

§

fn len(&self) -> usize

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

§

fn is_empty(&self) -> bool

Returns whether this array is empty. Read more

§

fn shrink_to_fit(&mut self)

Shrinks the capacity of any exclusively owned buffer as much as possible Read more

§

fn offset(&self) -> usize

Returns the offset into the underlying data used by this array(-slice). Note that the underlying data can be shared by many arrays. This defaults to 0. Read more

§

fn nulls(&self) -> Option<&NullBuffer>

Returns the null buffer of this array if any. Read more

§

fn logical_null_count(&self) -> usize

Returns the total number of logical null values in this array. Read more

§

fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory pointed to by this array. The buffers store bytes in the Arrow memory format, and include the data as well as the validity map. Note that this does not always correspond to the exact memory usage of an array, since multiple arrays can share the same buffers or slices thereof.

§

fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this array. This value will always be greater than returned by get_buffer_memory_size() and includes the overhead of the data structures that contain the pointers to the various buffers.

§

fn claim(&self, pool: &dyn MemoryPool)

Claim memory used by this array in the provided memory pool. Read more

§

fn logical_nulls(&self) -> Option<NullBuffer>

Returns a potentially computed NullBuffer that represents the logical null values of this array, if any. Read more

§

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

Returns whether the element at index is null according to Array::nulls Read more

§

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

Returns whether the element at index is not null, the opposite of Self::is_null. Read more

§

fn null_count(&self) -> usize

Returns the total number of physical null values in this array. Read more

§

fn is_nullable(&self) -> bool

Returns false if the array is guaranteed to not contain any logical nulls Read more

§

impl<'a, T> ArrayAccessor for &'a GenericByteArray<T>
where T: ByteArrayType,

§

type Item = &'a <T as ByteArrayType>::Native

The Arrow type of the element being accessed.

§

fn value( &self, index: usize, ) -> <&'a GenericByteArray<T> as ArrayAccessor>::Item

Returns the element at index i Read more

§

unsafe fn value_unchecked( &self, index: usize, ) -> <&'a GenericByteArray<T> as ArrayAccessor>::Item

Returns the element at index i Read more

§

impl<'a, O> BinaryArrayType<'a> for &'a GenericByteArray<GenericBinaryType<O>>
where O: OffsetSizeTrait,

§

fn iter(&self) -> ArrayIter<&'a GenericByteArray<GenericBinaryType<O>>> ⓘ

Constructs a new iterator

§

impl<T> Clone for GenericByteArray<T>
where T: ByteArrayType,

§

fn clone(&self) -> GenericByteArray<T>

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

§

impl<T> Debug for GenericByteArray<T>
where T: ByteArrayType,

§

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

Formats the value using the given formatter. Read more

§

impl<O> DisplayIndex for &GenericByteArray<GenericBinaryType<O>>
where O: OffsetSizeTrait,

§

fn write(&self, idx: usize, f: &mut dyn Write) -> Result<(), FormatError>

Write the value of the underlying array at idx to f.

§

impl<FROM, V> From<&GenericByteArray<FROM>> for GenericByteViewArray<V>
where FROM: ByteArrayType, <FROM as ByteArrayType>::Offset: OffsetSizeTrait + ToPrimitive, V: ByteViewType<Native = <FROM as ByteArrayType>::Native>,

Efficiently convert a GenericByteArray to a GenericByteViewArray

For example this method can convert a StringArray to a StringViewArray.

If the offsets are all less than u32::MAX, the new GenericByteViewArray is built without copying the underlying string data (views are created directly into the existing buffer)

§