Struct GenericWkbArray

pub struct GenericWkbArray<O: OffsetSizeTrait> { /* private fields */ }

An immutable array of WKB geometries.

This is stored either as an Arrow BinaryArray or LargeBinaryArray and is semantically equivalent to Vec<Option<Wkb>> due to the internal validity bitmap.

Refer to crate::cast for converting this array to other GeoArrow array types.

Implementations

impl<O: OffsetSizeTrait> GenericWkbArray<O>

pub fn new(array: GenericBinaryArray<O>, metadata: Arc<Metadata>) -> Self

Create a new GenericWkbArray from a BinaryArray

pub fn is_empty(&self) -> bool

Returns true if the array is empty

pub fn buffer_lengths(&self) -> WkbCapacity

The lengths of each buffer contained in this array.

pub fn num_bytes(&self) -> usize

The number of bytes occupied by this array.

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

Slice this GenericWkbArray.

Panic

This function panics iff offset + length > self.len().

pub fn with_metadata(&self, metadata: Arc<Metadata>) -> Self

Replace the Metadata in the array with the given metadata

Trait Implementations

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

fn clone(&self) -> GenericWkbArray<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O: Debug + OffsetSizeTrait> Debug for GenericWkbArray<O>

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

Formats the value using the given formatter.

impl<O: OffsetSizeTrait> From<(GenericByteArray<GenericBinaryType<O>>, WkbType)> for GenericWkbArray<O>

fn from((value, typ): (GenericBinaryArray<O>, WkbType)) -> Self

Converts to this type from the input type.

impl<O: OffsetSizeTrait> From<GenericWkbArray<O>> for WkbViewArray

fn from(value: GenericWkbArray<O>) -> Self

Converts to this type from the input type.

impl From<GenericWkbArray<i32>> for GenericWkbArray<i64>

fn from(value: GenericWkbArray<i32>) -> Self

Converts to this type from the input type.

impl<O: OffsetSizeTrait> From<WkbViewArray> for GenericWkbArray<O>

fn from(value: WkbViewArray) -> Self

Converts to this type from the input type.

impl<O: OffsetSizeTrait> GeoArrowArray for GenericWkbArray<O>

fn as_any(&self) -> &dyn Any

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

fn into_array_ref(self) -> ArrayRef

Converts this array into an Arced arrow array, consuming the original array.

fn to_array_ref(&self) -> ArrayRef

Converts this array into an Arced arrow array.

fn len(&self) -> usize

The number of geometries contained in this array.

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

Returns a potentially computed `NullBuffer`` that represents the logical null values of this array, if any.

fn logical_null_count(&self) -> usize

Returns the number of null slots in this array.

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

Returns whether slot i is null.

fn data_type(&self) -> GeoArrowType

Returns the GeoArrowType of this array.

fn slice(&self, offset: usize, length: usize) -> Arc<dyn GeoArrowArray>

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

fn with_metadata(self, metadata: Arc<Metadata>) -> Arc<dyn GeoArrowArray>

Change the Metadata of this array.

fn is_empty(&self) -> bool

Returns true if the array is empty.

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

Returns whether slot i is valid.

impl<'a, O: OffsetSizeTrait> GeoArrowArrayAccessor<'a> for GenericWkbArray<O>

type Item = Wkb<'a>

The geoarrow scalar object for this geometry array type.

unsafe fn value_unchecked(&'a self, index: usize) -> GeoArrowResult<Self::Item>

Returns the element at index i, not considering validity.

fn value(&'a self, index: usize) -> GeoArrowResult<Self::Item>

Returns the element at index i, not considering validity.

fn get(&'a self, index: usize) -> GeoArrowResult<Option<Self::Item>>

Returns the value at slot i as an Arrow scalar, considering validity.

unsafe fn get_unchecked( &'a self, index: usize, ) -> Option<GeoArrowResult<Self::Item>>

Returns the value at slot i as an Arrow scalar, considering validity.

fn iter( &'a self, ) -> impl ExactSizeIterator<Item = Option<GeoArrowResult<Self::Item>>> + 'a

Iterates over this array’s geoarrow scalar values, considering validity.

fn iter_values( &'a self, ) -> impl ExactSizeIterator<Item = GeoArrowResult<Self::Item>> + 'a

Iterator over geoarrow scalar values, not considering validity.

impl<O: OffsetSizeTrait> IntoArrow for GenericWkbArray<O>

type ArrowArray = GenericByteArray<GenericBinaryType<O>>

The type of arrow array that this geoarrow array can be converted into.

type ExtensionType = WkbType

The extension type representing this array. It will always be a type defined by geoarrow_schema.

fn into_arrow(self) -> Self::ArrowArray

Converts this geoarrow array into an arrow array.

fn extension_type(&self) -> &Self::ExtensionType

Return the Arrow extension type representing this array.

impl<O: PartialEq + OffsetSizeTrait> PartialEq for GenericWkbArray<O>

fn eq(&self, other: &GenericWkbArray<O>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<(&dyn Array, &Field)> for GenericWkbArray<i32>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from((arr, field): (&dyn Array, &Field)) -> GeoArrowResult<Self>

Performs the conversion.

impl TryFrom<(&dyn Array, &Field)> for GenericWkbArray<i64>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from((arr, field): (&dyn Array, &Field)) -> GeoArrowResult<Self>

Performs the conversion.

impl TryFrom<(&dyn Array, WkbType)> for GenericWkbArray<i32>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from((value, typ): (&dyn Array, WkbType)) -> GeoArrowResult<Self>

Performs the conversion.

impl TryFrom<(&dyn Array, WkbType)> for GenericWkbArray<i64>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from((value, typ): (&dyn Array, WkbType)) -> GeoArrowResult<Self>

Performs the conversion.

impl TryFrom<GenericWkbArray<i64>> for GenericWkbArray<i32>

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: GenericWkbArray<i64>) -> GeoArrowResult<Self>

Performs the conversion.

impl GenericWkbArrayType<'_> for GenericWkbArray<i32>

impl GenericWkbArrayType<'_> for GenericWkbArray<i64>

impl<O: OffsetSizeTrait> StructuralPartialEq for GenericWkbArray<O>