Struct arrow::array::GenericByteArray

pub struct GenericByteArray<T>where
    T: ByteArrayType,{ /* private fields */ }

Generic struct for variable-size byte arrays

See StringArray and LargeStringArray for storing utf8 encoded string data

See BinaryArray and LargeBinaryArray for storing arbitrary bytes

Implementations

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

pub const fn get_data_type() -> DataType

👎Deprecated: please use Self::DATA_TYPE instead

Get the data type of the array.

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

Creates a GenericBinaryArray from a vector of byte slices

See also Self::from_iter_values

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

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

pub fn from_iter_values<Ptr, I>( iter: I ) -> GenericByteArray<GenericBinaryType<OffsetSize>>where Ptr: AsRef<[u8]>, I: IntoIterator<Item = Ptr>,

Creates a GenericBinaryArray based on an iterator of values without nulls

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

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]>> + 'a

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 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 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

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

Panics

Panics if index i is out of bounds.

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

constructs a new iterator

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 const fn get_data_type() -> DataType

👎Deprecated: please use Self::DATA_TYPE instead

Get the data type of the array.

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 from_iter_values<Ptr, I>( iter: I ) -> GenericByteArray<GenericStringType<OffsetSize>>where Ptr: AsRef<str>, I: IntoIterator<Item = Ptr>,

Creates a GenericStringArray based on an iterator of values without nulls

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

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>> + 'a

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,

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

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

fn data(&self) -> &ArrayData

Returns a reference to the underlying data of this array

fn to_data(&self) -> ArrayData

Returns the underlying data of this array

fn into_data(self) -> ArrayData

Returns the underlying data of this array

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

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

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

Returns the null buffers of this array if any

fn data_ref(&self) -> &ArrayData

Returns a reference-counted pointer to the underlying data of this array.

fn data_type(&self) -> &DataType

Returns a reference to the DataType of this array.

fn len(&self) -> usize

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

fn is_empty(&self) -> bool

Returns whether this array is empty.

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.

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

Returns whether the element at index is null. When using this function on a slice, the index is relative to the slice.

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

Returns whether the element at index is not null. When using this function on a slice, the index is relative to the slice.

fn null_count(&self) -> usize

Returns the total number of null values in this array.

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.

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.

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

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

Returns the element at index i

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T> From<ArrayData> for GenericByteArray<T>where T: ByteArrayType,

fn from(data: ArrayData) -> GenericByteArray<T>

Converts to this type from the input type.

impl<OffsetSize> From<GenericByteArray<GenericBinaryType<OffsetSize>>> for GenericByteArray<GenericStringType<OffsetSize>>where OffsetSize: OffsetSizeTrait,

fn from( v: GenericByteArray<GenericBinaryType<OffsetSize>> ) -> GenericByteArray<GenericStringType<OffsetSize>>

Converts to this type from the input type.

impl<OffsetSize> From<GenericByteArray<GenericStringType<OffsetSize>>> for GenericByteArray<GenericBinaryType<OffsetSize>>where OffsetSize: OffsetSizeTrait,

fn from( value: GenericByteArray<GenericStringType<OffsetSize>> ) -> GenericByteArray<GenericBinaryType<OffsetSize>>

Converts to this type from the input type.

impl<T> From<GenericByteArray<T>> for ArrayDatawhere T: ByteArrayType,

fn from(array: GenericByteArray<T>) -> ArrayData

Converts to this type from the input type.

impl<OffsetSize> From<GenericListArray<OffsetSize>> for GenericByteArray<GenericStringType<OffsetSize>>where OffsetSize: OffsetSizeTrait,

fn from( v: GenericListArray<OffsetSize> ) -> GenericByteArray<GenericStringType<OffsetSize>>

Converts to this type from the input type.

impl<T> From<GenericListArray<T>> for GenericByteArray<GenericBinaryType<T>>where T: OffsetSizeTrait,

fn from(v: GenericListArray<T>) -> GenericByteArray<GenericBinaryType<T>>

Converts to this type from the input type.

impl<OffsetSize> From<Vec<&[u8], Global>> for GenericByteArray<GenericBinaryType<OffsetSize>>where OffsetSize: OffsetSizeTrait,

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

Converts to this type from the input type.

impl<OffsetSize> From<Vec<&str, Global>> for GenericByteArray<GenericStringType<OffsetSize>>where OffsetSize: OffsetSizeTrait,

fn from(v: Vec<&str, Global>) -> GenericByteArray<GenericStringType<OffsetSize>>

Converts to this type from the input type.

impl<OffsetSize> From<Vec<Option<&[u8]>, Global>> for GenericByteArray<GenericBinaryType<OffsetSize>>where OffsetSize: OffsetSizeTrait,

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

Converts to this type from the input type.

impl<OffsetSize> From<Vec<Option<&str>, Global>> for GenericByteArray<GenericStringType<OffsetSize>>where OffsetSize: OffsetSizeTrait,

fn from( v: Vec<Option<&str>, Global> ) -> GenericByteArray<GenericStringType<OffsetSize>>

Converts to this type from the input type.

impl<OffsetSize> From<Vec<Option<String>, Global>> for GenericByteArray<GenericStringType<OffsetSize>>where OffsetSize: OffsetSizeTrait,

fn from( v: Vec<Option<String>, Global> ) -> GenericByteArray<GenericStringType<OffsetSize>>

Converts to this type from the input type.

impl<OffsetSize> From<Vec<String, Global>> for GenericByteArray<GenericStringType<OffsetSize>>where OffsetSize: OffsetSizeTrait,

fn from( v: Vec<String, Global> ) -> GenericByteArray<GenericStringType<OffsetSize>>

Converts to this type from the input type.

impl<'a, Ptr, OffsetSize> FromIterator<&'a Option<Ptr>> for GenericByteArray<GenericStringType<OffsetSize>>where OffsetSize: OffsetSizeTrait, Ptr: AsRef<str> + 'a,

fn from_iter<I>(iter: I) -> GenericByteArray<GenericStringType<OffsetSize>>where I: IntoIterator<Item = &'a Option<Ptr>>,

Creates a GenericStringArray based on an iterator of Option references.

impl<Ptr, OffsetSize> FromIterator<Option<Ptr>> for GenericByteArray<GenericBinaryType<OffsetSize>>where OffsetSize: OffsetSizeTrait, Ptr: AsRef<[u8]>,

fn from_iter<I>(iter: I) -> GenericByteArray<GenericBinaryType<OffsetSize>>where I: IntoIterator<Item = Option<Ptr>>,

Creates a value from an iterator.

impl<Ptr, OffsetSize> FromIterator<Option<Ptr>> for GenericByteArray<GenericStringType<OffsetSize>>where OffsetSize: OffsetSizeTrait, Ptr: AsRef<str>,

fn from_iter<I>(iter: I) -> GenericByteArray<GenericStringType<OffsetSize>>where I: IntoIterator<Item = Option<Ptr>>,

Creates a GenericStringArray based on an iterator of Options

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

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

The type of the elements being iterated over.

type IntoIter = ArrayIter<&'a GenericByteArray<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a GenericByteArray<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

fn eq(&self, other: &GenericByteArray<GenericBinaryType<OffsetSize>>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn eq(&self, other: &GenericByteArray<GenericStringType<OffsetSize>>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.