Struct PolygonType 

pub struct PolygonType { /* private fields */ }

A GeoArrow Polygon type.

Refer to the GeoArrow specification.

Implementations

impl PolygonType

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 PolygonType

pub fn data_type(&self) -> DataType

Convert to the corresponding DataType.

use arrow_schema::{DataType, Field};
use geoarrow_schema::{Dimension, PolygonType};

let geom_type = PolygonType::new(Dimension::XYZ, Default::default());

let expected_coord_type = DataType::Struct(
    vec![
        Field::new("x", DataType::Float64, false),
        Field::new("y", DataType::Float64, false),
        Field::new("z", DataType::Float64, false),
    ]
    .into(),
);
let vertices_field = Field::new("vertices", expected_coord_type, false);
let rings_field = Field::new_list("rings", vertices_field, false);
let expected_type = DataType::List(rings_field.into());
assert_eq!(geom_type.data_type(), expected_type);

Trait Implementations

impl Clone for PolygonType

fn clone(&self) -> PolygonType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolygonType

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

Formats the value using the given formatter.

impl ExtensionType for PolygonType

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

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<PolygonType> for GeoArrowType

fn from(value: PolygonType) -> Self

Converts to this type from the input type.

impl GeometryTypeId for PolygonType

const GEOMETRY_TYPE_OFFSET: i8 = 3i8

The integer offset for this geometry type.

fn dimension(&self) -> Dimension

The dimension of this geometry type.

fn geometry_type_id(&self) -> i8

The Type ID for this geometry type and dimension.

impl Hash for PolygonType

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 PolygonType

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

impl StructuralPartialEq for PolygonType