Struct GeometryCollectionType

pub struct GeometryCollectionType { /* private fields */ }

A GeoArrow GeometryCollection type.

Refer to the GeoArrow specification.

Implementations

impl GeometryCollectionType

pub fn new(dim: Dimension, metadata: Arc<Metadata>) -> Self

Construct a new type from parts.

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

Change the underlying CoordType

pub fn with_dimension(self, dim: Dimension) -> Self

Change the underlying Dimension

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

Change the underlying Metadata

pub fn coord_type(&self) -> CoordType

Retrieve the underlying CoordType

pub fn dimension(&self) -> Dimension

Retrieve the underlying Dimension

pub fn metadata(&self) -> &Arc<Metadata>

Retrieve the underlying Metadata

pub fn to_field<N: Into<String>>(&self, name: N, nullable: bool) -> Field

Convert this type to a Field, retaining extension metadata.

pub fn into_inner(self) -> (CoordType, Dimension, Arc<Metadata>)

Extract into components

impl GeometryCollectionType

pub fn data_type(&self) -> DataType

Convert to the corresponding DataType.

use std::sync::Arc;

use arrow_schema::{DataType, Field, UnionFields, UnionMode};
use geoarrow_schema::{
    Dimension, GeometryCollectionType, LineStringType, Metadata, MultiLineStringType,
    MultiPointType, MultiPolygonType, PointType, PolygonType,
};

let dim = Dimension::XY;
let metadata = Arc::new(Metadata::default());
let geom_type = GeometryCollectionType::new(dim, metadata.clone());

let fields = vec![
    Field::new(
        "Point",
        PointType::new(dim, metadata.clone()).data_type(),
        true,
    ),
    Field::new(
        "LineString",
        LineStringType::new(dim, metadata.clone()).data_type(),
        true,
    ),
    Field::new(
        "Polygon",
        PolygonType::new(dim, metadata.clone()).data_type(),
        true,
    ),
    Field::new(
        "MultiPoint",
        MultiPointType::new(dim, metadata.clone()).data_type(),
        true,
    ),
    Field::new(
        "MultiLineString",
        MultiLineStringType::new(dim, metadata.clone()).data_type(),
        true,
    ),
    Field::new(
        "MultiPolygon",
        MultiPolygonType::new(dim, metadata.clone()).data_type(),
        true,
    ),
];
let type_ids = vec![1, 2, 3, 4, 5, 6];

let union_fields = UnionFields::new(type_ids, fields);
let union_data_type = DataType::Union(union_fields, UnionMode::Dense);

let geometries_field = Field::new("geometries", union_data_type, false).into();
let expected_type = DataType::List(geometries_field);

assert_eq!(geom_type.data_type(), expected_type);

Trait Implementations

impl Clone for GeometryCollectionType

fn clone(&self) -> GeometryCollectionType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeometryCollectionType

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

Formats the value using the given formatter.

impl ExtensionType for GeometryCollectionType

const NAME: &'static str = "geoarrow.geometrycollection"

The name identifying this extension type.

type Metadata = Arc<Metadata>

The metadata type of this extension type.

fn metadata(&self) -> &Self::Metadata

Returns a reference to the metadata of this extension type, or &() if if this extension type defines no metadata (Self::Metadata=()).

fn serialize_metadata(&self) -> Option<String>

Returns the serialized representation of the metadata of this extension type, or None if this extension type defines no metadata (Self::Metadata=()).

fn deserialize_metadata( metadata: Option<&str>, ) -> Result<Self::Metadata, ArrowError>

Deserialize the metadata of this extension type from the serialized representation of the metadata. An extension type that defines no metadata should expect None for the serialized metadata and return Ok(()).

fn supports_data_type(&self, data_type: &DataType) -> Result<(), ArrowError>

Returns Ok(()) iff the given data type is supported by this extension type.

fn try_new( data_type: &DataType, metadata: Self::Metadata, ) -> Result<Self, ArrowError>

Construct this extension type for a field with the given data type and metadata.

impl From<GeometryCollectionType> for GeoArrowType

fn from(value: GeometryCollectionType) -> Self

Converts to this type from the input type.

impl Hash for GeometryCollectionType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for GeometryCollectionType

fn eq(&self, other: &GeometryCollectionType) -> 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 Eq for GeometryCollectionType

impl StructuralPartialEq for GeometryCollectionType