Skip to main content

GenericStringArray

Struct GenericStringArray 

Source
pub struct GenericStringArray<O: OffsetSizeTrait> { /* private fields */ }
Expand description

A column of variable-length UTF-8 strings.

Use the StringArray and LargeStringArray aliases rather than naming the offset parameter directly.

Implementations§

Source§

impl<O: OffsetSizeTrait> GenericStringArray<O>

Source

pub fn try_new( offsets: ScalarBuffer<O>, values: Buffer, validity: Option<Bitmap>, ) -> Result<Self>

Builds an array from its three buffers, validating offsets and UTF-8.

This is the constructor for untrusted bytes.

§Errors
Source

pub unsafe fn new_unchecked( offsets: ScalarBuffer<O>, values: Buffer, validity: Option<Bitmap>, ) -> Self

Builds an array from its three buffers without validating.

§Safety

This constructor is unsafe by contract, not by memory model: the accessors stay memory-safe whatever the bytes say, returning None for a slot that is not valid UTF-8. Skipping validation turns a decode error into a silent None, so only use it on the trusted zero-copy path — bytes this crate produced, or bytes a caller has already validated.

Callers must guarantee the offsets satisfy crate::array::validate_offsets and that every slot they carve out is valid UTF-8.

Source

pub fn from_values<V: AsRef<str>>(values: impl IntoIterator<Item = V>) -> Self

Builds an array with no nulls.

use astrs_data::array::{Array, StringArray};

let names = StringArray::from_values(["lidar", "camera"]);
assert_eq!(names.len(), 2);
assert_eq!(names.get(1), Some("camera"));
Source

pub fn from_opt_iter<V: AsRef<str>>( values: impl IntoIterator<Item = Option<V>>, ) -> Self

Builds an array from optional strings.

Source

pub fn new_null(len: usize) -> Self

An all-null array of len slots.

Source

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

The offset buffer, len + 1 entries.

Source

pub const fn offsets_buffer(&self) -> &ScalarBuffer<O>

The offset buffer as a shareable typed window.

See GenericBinaryArray::offsets_buffer: the IPC encoder clones this window instead of copying the offsets out of a slice.

use astrs_data::array::StringArray;

let array = StringArray::from_values(["ab", "c"]);
assert_eq!(array.offsets_buffer().as_slice(), &[0, 2, 3]);
Source

pub const fn value_data(&self) -> &Buffer

The flat value region every slot points into.

Source

pub fn value_bytes(&self, index: usize) -> Option<&[u8]>

The raw slot bytes at index, ignoring validity and skipping the UTF-8 check.

The cheapest accessor: no validation at all.

Source

pub fn value(&self, index: usize) -> Option<&str>

The raw slot text at index, ignoring validity.

Returns None when index is out of range (or, on the Self::new_unchecked path only, when the slot is not valid UTF-8).

Source

pub fn get(&self, index: usize) -> Option<&str>

The logical value at index: None when the slot is null or out of range.

Source

pub fn value_length(&self, index: usize) -> Option<usize>

Byte length of slot index — not the character count.

Source

pub fn total_value_bytes(&self) -> usize

Total bytes the values occupy, across the whole array.

Source

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

Iterates over the logical values, None for nulls.

Source

pub fn slice(&self, offset: usize, len: usize) -> Self

A zero-copy sub-range, clamped to the array (the crate-wide slicing convention).

Slicing preserves the UTF-8 invariant: it narrows the offset buffer without changing any offset, and every retained offset was already checked to be a character boundary.

Source

pub fn try_slice(&self, offset: usize, len: usize) -> Result<Self>

Checked GenericStringArray::slice.

§Errors

DataError::SliceOutOfBounds when the window leaves the array.

Source

pub fn with_validity(&self, validity: Option<Bitmap>) -> Result<Self>

Returns a copy with a different validity bitmap.

§Errors

DataError::ValidityLengthMismatch when the bitmap length is wrong.

Source

pub fn into_binary(self) -> GenericBinaryArray<O>

Reinterprets the column as bytes, dropping the UTF-8 guarantee.

Free: the two types share a representation.

Source

pub const fn as_binary(&self) -> &GenericBinaryArray<O>

The byte view of this column.

Trait Implementations§

Source§

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

Source§

fn as_any(&self) -> &dyn Any

Erased self, for ArrayExt::downcast.
Source§

fn data_type(&self) -> &DataType

The array’s layout.
Source§

fn len(&self) -> usize

Number of logical slots.
Source§

fn validity(&self) -> Option<&Bitmap>

The validity bitmap, or None when every slot is valid. Read more
Source§

fn slice(&self, offset: usize, len: usize) -> ArrayRef

A zero-copy sub-range. Read more
Source§

fn buffer_memory_size(&self) -> usize

Bytes of buffer memory this array pins, including shared allocations it only partly covers. Read more
Source§

fn equals(&self, other: &dyn Array) -> bool

Structural equality against another array, used by the PartialEq implementation on dyn Array. Read more
Source§

fn is_empty(&self) -> bool

Returns true when the array has no slots.
Source§

fn null_count(&self) -> usize

Number of null slots.
Source§

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

Returns true when slot index is null. Out-of-range indices are reported as null.
Source§

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

Returns true when slot index holds a value.
Source§

fn children(&self) -> Vec<&ArrayRef> ⓘ

The child arrays this array owns, in field order. Empty for leaf types.
Source§

impl<'a, O: OffsetSizeTrait> ArrayAccessor for &'a GenericStringArray<O>

Source§

type Item = &'a str

The logical value type, e.g. i32, &'a str or &'a [u8].
Source§

fn accessor_len(&self) -> usize

Number of logical slots.
Source§

fn accessor_get(&self, index: usize) -> Option<&'a str>

The value at index, or None when the slot is null or out of range.
Source§

impl<O: Clone + OffsetSizeTrait> Clone for GenericStringArray<O>

Source§

fn clone(&self) -> Self

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

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

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<O: OffsetSizeTrait> Eq for GenericStringArray<O>

Source§

impl<O: OffsetSizeTrait, V: AsRef<str>> FromIterator<Option<V>> for GenericStringArray<O>

Source§

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

Creates a value from an iterator. Read more
Source§

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

Source§

type Item = Option<&'a str>

The type of the elements being iterated over.
Source§

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

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

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

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<O: OffsetSizeTrait> TryFrom<GenericBinaryArray<O>> for GenericStringArray<O>

Source§

fn try_from(inner: GenericBinaryArray<O>) -> Result<Self>

Validates the bytes, then reinterprets them as text without copying.

Source§

type Error = DataError

The type returned in the event of a conversion error.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<A> IntoArrayRef for A
where A: Array,

Source§

fn into_array_ref(self) -> ArrayRef

Moves self into a shared, dynamically typed column.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.