Struct geoarrow2::array::geometrycollection::array::GeometryCollectionArray

pub struct GeometryCollectionArray<O: OffsetSizeTrait> {
    pub array: MixedGeometryArray<O>,
    pub geom_offsets: OffsetBuffer<O>,
    pub validity: Option<NullBuffer>,
    /* private fields */
}

An immutable array of GeometryCollection geometries using GeoArrow’s in-memory representation.

This is semantically equivalent to Vec<Option<GeometryCollection>> due to the internal validity bitmap.

Fields

array: MixedGeometryArray<O>

geom_offsets: OffsetBuffer<O>

Offsets into the mixed geometry array where each geometry starts

validity: Option<NullBuffer>

Validity bitmap

Implementations

impl<O: OffsetSizeTrait> GeometryCollectionArray<O>

pub fn new( array: MixedGeometryArray<O>, geom_offsets: OffsetBuffer<O>, validity: Option<NullBuffer> ) -> Self

Create a new GeometryCollectionArray from parts

Implementation

This function is O(1).

impl<O: OffsetSizeTrait> GeometryCollectionArray<O>

pub fn iter_geo_values(&self) -> impl Iterator<Item = GeometryCollection> + '_

Iterator over geo Geometry objects, not looking at validity

pub fn iter_geo( &self ) -> ZipValidity<GeometryCollection, impl Iterator<Item = GeometryCollection> + '_, BitIterator<'_>>

Iterator over geo Geometry objects, taking into account validity

impl<'a, O: OffsetSizeTrait> GeometryCollectionArray<O>

pub fn iter(&'a self) -> GeometryCollectionArrayIter<'_, O>

Returns an iterator of Option<GeometryCollection>

Trait Implementations

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

fn clone(&self) -> GeometryCollectionArray<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 GeometryCollectionArray<O>

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

Formats the value using the given formatter.

impl<A: OffsetSizeTrait, B: OffsetSizeTrait> From<&GeometryCollectionArray<A>> for WKBArray<B>

fn from(value: &GeometryCollectionArray<A>) -> Self

Converts to this type from the input type.

impl<'a, O: OffsetSizeTrait> GeoArrayAccessor<'a> for GeometryCollectionArray<O>

type Item = GeometryCollection<'a, O>

The geoarrow scalar object for this geometry array type.

type ItemGeo = GeometryCollection

The geo scalar object for this geometry array type.

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

Returns the element at index i

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

Returns the element at index i

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

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

fn value_as_geo(&'a self, i: usize) -> Self::ItemGeo

Access the value at slot i as a geo scalar, not considering validity.

fn get_as_geo(&'a self, i: usize) -> Option<Self::ItemGeo>

Access the value at slot i as a geo scalar, considering validity.

impl<'a, O: OffsetSizeTrait> GeometryArrayTrait<'a> for GeometryCollectionArray<O>

fn len(&self) -> usize

Returns the number of geometries in this array

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

Returns the optional validity.

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

Slices this GeometryCollectionArray in place.

Implementation

This operation is O(1) as it amounts to increase two ref counts.

Examples

use arrow::array::PrimitiveArray;
use arrow_array::types::Int32Type;

let array: PrimitiveArray<Int32Type> = PrimitiveArray::from(vec![1, 2, 3]);
assert_eq!(format!("{:?}", array), "PrimitiveArray<Int32>\n[\n  1,\n  2,\n  3,\n]");
let sliced = array.slice(1, 1);
assert_eq!(format!("{:?}", sliced), "PrimitiveArray<Int32>\n[\n  2,\n]");

// note: `sliced` and `array` share the same memory region.

Panic

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

fn as_any(&self) -> &dyn Any

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

fn data_type(&self) -> &GeoDataType

Returns a reference to the DataType of this array.

fn storage_type(&self) -> DataType

Get the logical DataType of this array.

fn extension_field(&self) -> Arc<Field>

Get the extension type of this array, as defined by the GeoArrow specification.

fn extension_name(&self) -> &str

Get the extension name of this array.

fn into_array_ref(self) -> Arc<dyn Array>

Convert this array into an arced arrow array.

fn with_coords(self, _coords: CoordBuffer) -> Self

Create a new array with replaced coordinates

fn coord_type(&self) -> CoordType

Get the coordinate type of this geometry array, either interleaved or separated.

fn into_coord_type(self, _coord_type: CoordType) -> Self

Cast the coordinate buffer of this geometry array to the given coordinate type.

fn owned_slice(&self, _offset: usize, _length: usize) -> Self

A slice that fully copies the contents of the underlying buffer

fn is_empty(&self) -> bool

Returns true if the array is empty.

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

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

fn null_count(&self) -> usize

The number of null slots in this array.

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

Returns whether slot i is null.

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

Returns whether slot i is valid.

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

type ArrowArray = GenericListArray<O>

fn into_arrow(self) -> Self::ArrowArray

impl<'a, O: OffsetSizeTrait> RTree<'a> for GeometryCollectionArray<O>

type RTreeObject = CachedEnvelope<GeometryCollection<'a, O>>

The object type to store in the RTree.

fn rstar_tree(&'a self) -> RTree<Self::RTreeObject>

Build an RTree spatial index containing this array’s geometries.