Struct arrow_array::array::GenericStringArray

pub struct GenericStringArray<OffsetSize: OffsetSizeTrait> { /* private fields */ }

Generic struct for [Large]StringArray

See StringArray and LargeStringArray for storing specific string data.

Implementations

impl<OffsetSize: OffsetSizeTrait> GenericStringArray<OffsetSize>

pub const DATA_TYPE: DataType = _

Data type of the array.

pub const fn get_data_type() -> DataType

👎Deprecated: please use Self::DATA_TYPE instead

Get the data type of the array.

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

Returns the length for the element at index i.

pub fn value_offsets(&self) -> &[OffsetSize]

Returns the offset values in the offsets buffer

pub fn value_data(&self) -> Buffer

Returns a clone of the value data buffer

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 unsafe fn value_unchecked(&self, i: usize) -> &str

Returns the element at index

Safety

caller is responsible for ensuring that index is within the array bounds

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

Returns the element at index i as &str

Panics

Panics if index i is out of bounds.

pub fn from_iter_values<Ptr, I>(iter: I) -> Selfwhere
    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<&'_ 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<&'_ 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()

impl<'a, T: OffsetSizeTrait> GenericStringArray<T>

pub fn iter(&'a self) -> GenericStringIter<'a, T>

constructs a new iterator

Trait Implementations

impl<OffsetSize: OffsetSizeTrait> Array for GenericStringArray<OffsetSize>

fn as_any(&self) -> &dyn Any

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 into_data(self) -> ArrayData

Returns the underlying data of this array.

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 slice(&self, offset: usize, length: usize) -> ArrayRef

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

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, OffsetSize: OffsetSizeTrait> ArrayAccessor for &'a GenericStringArray<OffsetSize>

type Item = &'a str

fn value(&self, index: usize) -> Self::Item

Returns the element at index i

unsafe fn value_unchecked(&self, index: usize) -> Self::Item

Returns the element at index i

impl<OffsetSize: OffsetSizeTrait> Debug for GenericStringArray<OffsetSize>

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

Formats the value using the given formatter.

impl<OffsetSize: OffsetSizeTrait> From<ArrayData> for GenericStringArray<OffsetSize>

fn from(data: ArrayData) -> Self

Converts to this type from the input type.

impl<OffsetSize: OffsetSizeTrait> From<GenericBinaryArray<OffsetSize>> for GenericStringArray<OffsetSize>

fn from(v: GenericBinaryArray<OffsetSize>) -> Self

Converts to this type from the input type.

impl<OffsetSize: OffsetSizeTrait> From<GenericListArray<OffsetSize>> for GenericStringArray<OffsetSize>

fn from(v: GenericListArray<OffsetSize>) -> Self

Converts to this type from the input type.

impl<OffsetSize: OffsetSizeTrait> From<GenericStringArray<OffsetSize>> for ArrayData

fn from(array: GenericStringArray<OffsetSize>) -> Self

Converts to this type from the input type.

impl<OffsetSize: OffsetSizeTrait> From<Vec<&str, Global>> for GenericStringArray<OffsetSize>

fn from(v: Vec<&str>) -> Self

Converts to this type from the input type.

impl<OffsetSize: OffsetSizeTrait> From<Vec<Option<&str>, Global>> for GenericStringArray<OffsetSize>

fn from(v: Vec<Option<&str>>) -> Self

Converts to this type from the input type.

impl<OffsetSize: OffsetSizeTrait> From<Vec<String, Global>> for GenericStringArray<OffsetSize>

fn from(v: Vec<String>) -> Self

Converts to this type from the input type.

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

fn from_iter<I: IntoIterator<Item = &'a Option<Ptr>>>(iter: I) -> Self

Creates a GenericStringArray based on an iterator of Option references.

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

fn from_iter<I: IntoIterator<Item = Option<Ptr>>>(iter: I) -> Self

Creates a GenericStringArray based on an iterator of Options

impl<'a, T: OffsetSizeTrait> IntoIterator for &'a GenericStringArray<T>

type Item = Option<&'a str>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<OffsetSize: OffsetSizeTrait> PartialEq<GenericStringArray<OffsetSize>> for GenericStringArray<OffsetSize>

fn eq(&self, other: &Self) -> 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.