Struct MultiPolygonArray

pub struct MultiPolygonArray { /* private fields */ }

An immutable array of MultiPolygon geometries.

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

Implementations

impl MultiPolygonArray

pub fn new( coords: CoordBuffer, geom_offsets: OffsetBuffer<i32>, polygon_offsets: OffsetBuffer<i32>, ring_offsets: OffsetBuffer<i32>, nulls: Option<NullBuffer>, metadata: Arc<Metadata>, ) -> Self

Create a new MultiPolygonArray from parts

Implementation

This function is O(1).

Panics

• if the nulls is not None and its length is different from the number of geometries
• if the largest ring offset does not match the number of coordinates
• if the largest polygon offset does not match the size of ring offsets
• if the largest geometry offset does not match the size of polygon offsets

pub fn try_new( coords: CoordBuffer, geom_offsets: OffsetBuffer<i32>, polygon_offsets: OffsetBuffer<i32>, ring_offsets: OffsetBuffer<i32>, nulls: Option<NullBuffer>, metadata: Arc<Metadata>, ) -> GeoArrowResult<Self>

Create a new MultiPolygonArray from parts

Implementation

This function is O(1).

Errors

• if the nulls is not None and its length is different from the number of geometries
• if the largest ring offset does not match the number of coordinates
• if the largest polygon offset does not match the size of ring offsets
• if the largest geometry offset does not match the size of polygon offsets

pub fn coords(&self) -> &CoordBuffer

Access the underlying coordinate buffer

pub fn geom_offsets(&self) -> &OffsetBuffer<i32>

Access the underlying geometry offsets buffer

pub fn polygon_offsets(&self) -> &OffsetBuffer<i32>

Access the underlying polygon offsets buffer

pub fn ring_offsets(&self) -> &OffsetBuffer<i32>

Access the underlying ring offsets buffer

pub fn buffer_lengths(&self) -> MultiPolygonCapacity

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

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 MultiPolygonArray

fn clone(&self) -> MultiPolygonArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MultiPolygonArray

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

Formats the value using the given formatter.

impl From<MultiPolygonArray> for GeometryArray

fn from(value: MultiPolygonArray) -> Self

Converts to this type from the input type.

impl From<PolygonArray> for MultiPolygonArray

fn from(value: PolygonArray) -> Self

Converts to this type from the input type.

impl GeoArrowArray for MultiPolygonArray

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 MultiPolygonArray

type Item = MultiPolygon<'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 MultiPolygonArray

type ArrowArray = GenericListArray<i32>

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

type ExtensionType = MultiPolygonType

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 MultiPolygonArray

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<(&GenericListArray<i32>, MultiPolygonType)> for MultiPolygonArray

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from( (geom_array, typ): (&GenericListArray<i32>, MultiPolygonType), ) -> GeoArrowResult<Self>

Performs the conversion.

impl TryFrom<(&GenericListArray<i64>, MultiPolygonType)> for MultiPolygonArray

type Error = GeoArrowError

The type returned in the event of a conversion error.

fn try_from( (geom_array, typ): (&GenericListArray<i64>, MultiPolygonType), ) -> GeoArrowResult<Self>

Performs the conversion.

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

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, MultiPolygonType)> for MultiPolygonArray

type Error = GeoArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<O: OffsetSizeTrait> TryFrom<(GenericWkbArray<O>, MultiPolygonType)> for MultiPolygonArray

type Error = GeoArrowError

The type returned in the event of a conversion error.

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

Performs the conversion.