Skip to main content

GenericBinaryArray

Struct GenericBinaryArray 

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

A column of variable-length byte strings.

Use the BinaryArray and LargeBinaryArray aliases rather than naming the offset parameter directly.

Implementations§

Source§

impl<O: OffsetSizeTrait> GenericBinaryArray<O>

Source

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

Builds an array from its three buffers, validating the offsets.

§Errors
use astrs_data::array::{Array, BinaryArray};
use astrs_data::{Buffer, ScalarBuffer};

let array = BinaryArray::try_new(
    ScalarBuffer::from_slice(&[0, 2, 5]),
    Buffer::from_slice(b"aabbb"),
    None,
)?;
assert_eq!(array.get(1), Some(&b"bbb"[..]));
Source

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

Builds an array from its three buffers without validating offsets.

§Safety

This constructor is unsafe by contract, not by memory model: the accessors stay memory-safe whatever the offsets say (they use checked slicing and return None). Skipping validation means a malformed buffer silently produces None values instead of a decode error, which hides corruption. Only use it for offsets this crate itself produced — for example when re-wrapping buffers taken out of another array.

Callers must guarantee that offsets holds len + 1 non-decreasing, non-negative entries, all within values.len(), and that validity (if present) covers exactly len slots.

Source

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

Builds an array with no nulls from any iterator of byte slices.

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

let array = LargeBinaryArray::from_values([&b"one"[..], &b"two"[..]]);
assert_eq!(array.len(), 2);
assert_eq!(array.null_count(), 0);
Source

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

Builds an array from optional byte slices.

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.

GenericBinaryArray::value_offsets hands out a slice, which the IPC encoder cannot put on the wire without copying it. This accessor lets it clone the window instead — one atomic increment, no bytes moved.

use astrs_data::array::BinaryArray;

let array = BinaryArray::from_values([&b"ab"[..], &b"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(&self, index: usize) -> Option<&[u8]>

The raw slot bytes at index, ignoring validity.

Returns None only when index is out of range.

Source

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

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, ignoring validity.

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

Only the offset buffer is narrowed; the value region is shared as-is.

Source

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

Checked GenericBinaryArray::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.

Trait Implementations§

Source§

impl<O: OffsetSizeTrait> Array for GenericBinaryArray<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 GenericBinaryArray<O>

Source§

type Item = &'a [u8]

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 [u8]>

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

impl<O: Clone + OffsetSizeTrait> Clone for GenericBinaryArray<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 GenericBinaryArray<O>

Source§

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

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

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

Source§

impl<O: OffsetSizeTrait, V: AsRef<[u8]>> FromIterator<Option<V>> for GenericBinaryArray<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 GenericBinaryArray<O>

Source§

type Item = Option<&'a [u8]>

The type of the elements being iterated over.
Source§

type IntoIter = ArrayIter<&'a GenericBinaryArray<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 GenericBinaryArray<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.