Struct GeometryArray

pub struct GeometryArray { /* private fields */ }

An immutable array of geometries of unknown geometry type and dimension.

Implementations

impl GeometryArray

pub fn new( type_ids: ScalarBuffer<i8>, offsets: ScalarBuffer<i32>, points: [PointArray; 4], line_strings: [LineStringArray; 4], polygons: [PolygonArray; 4], mpoints: [MultiPointArray; 4], mline_strings: [MultiLineStringArray; 4], mpolygons: [MultiPolygonArray; 4], gcs: [GeometryCollectionArray; 4], metadata: Arc<Metadata>, ) -> Self

Create a new GeometryArray from parts

Implementation

This function is O(1).

Panics

• if the validity is not None and its length is different from the number of geometries
• if the largest geometry offset does not match the number of coordinates

pub fn buffer_lengths(&self) -> GeometryCapacity

The lengths of each buffer contained in this array.

pub fn type_ids(&self) -> &ScalarBuffer<i8>

Returns the type_ids buffer for this array

pub fn offsets(&self) -> &ScalarBuffer<i32>

Returns the offsets buffer for this array

pub fn has_dimension(&self, dim: Dimension) -> bool

Return true if this array holds at least one non-empty array of the given dimension

pub fn has_only_dimension(&self, dim: Dimension) -> bool

Return true if this array holds at least one geometry array of the given dimension and no arrays of any other dimension.

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

Implementation

This operation is O(F) where F is the number of fields.

Panic

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

pub fn into_coord_type(self, coord_type: CoordType) -> Self

Change the CoordType of this array.

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

Change the Metadata of this array.

Trait Implementations

impl Clone for GeometryArray

fn clone(&self) -> GeometryArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GeometryArray

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

Formats the value using the given formatter.

impl From<GeometryCollectionArray> for GeometryArray

fn from(value: GeometryCollectionArray) -> Self

Converts to this type from the input type.

impl From<LineStringArray> for GeometryArray

fn from(value: LineStringArray) -> Self

Converts to this type from the input type.

impl From<MultiLineStringArray> for GeometryArray

fn from(value: MultiLineStringArray) -> Self

Converts to this type from the input type.

impl From<MultiPointArray> for GeometryArray

fn from(value: MultiPointArray) -> Self

Converts to this type from the input type.

impl From<MultiPolygonArray> for GeometryArray

fn from(value: MultiPolygonArray) -> Self

Converts to this type from the input type.

impl From<PointArray> for GeometryArray

fn from(value: PointArray) -> Self

Converts to this type from the input type.

impl From<PolygonArray> for GeometryArray

fn from(value: PolygonArray) -> Self

Converts to this type from the input type.

impl GeoArrowArray for GeometryArray

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> GeoArrowArrayAccessor<'a> for GeometryArray

type Item = Geometry<'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 IntoArrow for GeometryArray

type ArrowArray = UnionArray

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

type ExtensionType = GeometryType

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 PartialEq for GeometryArray

fn eq(&self, other: &Self) -> 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<(&UnionArray, GeometryType)> for GeometryArray

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from((value, typ): (&UnionArray, GeometryType)) -> GeoArrowResult<Self>

Performs the conversion.

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

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, GeometryType)> for GeometryArray

type Error = GeoArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<O: OffsetSizeTrait> TryFrom<(GenericWkbArray<O>, GeometryType)> for GeometryArray

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from(value: (GenericWkbArray<O>, GeometryType)) -> GeoArrowResult<Self>

Performs the conversion.