Struct arrow::array::GenericStringArray

pub struct GenericStringArray<OffsetSize: StringOffsetSizeTrait> { /* fields omitted */ }

Generic struct for [Large]StringArray

Implementations

impl<OffsetSize: StringOffsetSizeTrait> GenericStringArray<OffsetSize>

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

pub fn from_iter_values<Ptr, I: IntoIterator<Item = Ptr>>(iter: I) -> Self where
    Ptr: AsRef<str>, 

Creates a GenericStringArray based on an iterator of values without nulls

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

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

constructs a new iterator

Trait Implementations

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

fn get_buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied by the buffers owned by this [$name].

fn get_array_memory_size(&self) -> usize

Returns the total number of bytes of memory occupied physically by this [$name].

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 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 to_raw(&self) -> Result<(*const FFI_ArrowArray, *const FFI_ArrowSchema)>

returns two pointers that represent this array in the C Data Interface (FFI)

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

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

Formats the value using the given formatter.

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

fn from(data: ArrayData) -> Self

Performs the conversion.

impl<T: StringOffsetSizeTrait> From<GenericListArray<T>> for GenericStringArray<T>

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

Performs the conversion.

impl<OffsetSize: StringOffsetSizeTrait> From<Vec<&'_ str, Global>> for GenericStringArray<OffsetSize>

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

Performs the conversion.

impl<OffsetSize: StringOffsetSizeTrait> From<Vec<Option<&'_ str>, Global>> for GenericStringArray<OffsetSize>

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

Performs the conversion.

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

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

Creates a value from an iterator.

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

type Item = Option<&'a str>

The type of the elements being iterated over.

type IntoIter = GenericStringIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<OffsetSize: StringOffsetSizeTrait> JsonEqual for GenericStringArray<OffsetSize>

fn equals_json(&self, json: &[&Value]) -> bool

Checks whether arrow array equals to json array.

fn equals_json_values(&self, json: &[Value]) -> bool

Checks whether arrow array equals to json array.

impl<OffsetSize: StringOffsetSizeTrait> 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 ==.

#[must_use]

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

This method tests for !=.

impl<OffsetSize: StringOffsetSizeTrait> PartialEq<Value> for GenericStringArray<OffsetSize>

fn eq(&self, json: &Value) -> bool

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

#[must_use]

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

This method tests for !=.