paleolimbot commented on code in PR #171:
URL: https://github.com/apache/sedona-db/pull/171#discussion_r2417028547
##########
rust/sedona-geometry/Cargo.toml:
##########
@@ -34,8 +34,10 @@ serde_json = { workspace = true }
wkt = { workspace = true }
[dependencies]
+datafusion-common = { workspace = true }
Review Comment:
We probably should not depend on datafusion-common or sedona-common here
(this is otherwise a pretty lightweight crate).
##########
rust/sedona-geometry/src/wkb_header.rs:
##########
@@ -0,0 +1,728 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::types::GeometryTypeId;
+use datafusion_common::{
+ error::{DataFusionError, Result},
+ exec_err,
+};
+use geo_traits::Dimensions;
+use sedona_common::sedona_internal_err;
+
+const SRID_FLAG_BIT: u32 = 0x20000000;
+
+/// Fast-path WKB header parser
+/// Performs operations lazily and caches them after the first computation
+pub struct WkbHeader {
+ geometry_type: u32,
+ // Not applicable for a point
+ // number of points for a linestring
+ // number of rings for a polygon
+ // number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ size: u32,
+ // SRID if given buffer was EWKB. Otherwise, 0.
+ srid: u32,
+ // First x,y coordinates for a point. Otherwise (f64::NAN, f64::NAN) if
empty
+ first_xy: (f64, f64),
+ // Dimensions of the first nested geometry of a collection or None if empty
+ // For POINT, LINESTRING, POLYGON, returns the dimensions of the geometry
+ first_geom_dimensions: Option<Dimensions>,
+}
+
+impl WkbHeader {
+ /// Creates a new [WkbHeader] from a buffer
+ pub fn try_new(buf: &[u8]) -> Result<Self> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> try_new");
Review Comment:
We should probably use `SedonaGeometryError` here (this should avoid a
datafusion-common and sedona-common dependency here)
##########
rust/sedona-geometry/src/wkb_header.rs:
##########
@@ -0,0 +1,728 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::types::GeometryTypeId;
+use datafusion_common::{
+ error::{DataFusionError, Result},
+ exec_err,
+};
+use geo_traits::Dimensions;
+use sedona_common::sedona_internal_err;
+
+const SRID_FLAG_BIT: u32 = 0x20000000;
+
+/// Fast-path WKB header parser
+/// Performs operations lazily and caches them after the first computation
+pub struct WkbHeader {
+ geometry_type: u32,
+ // Not applicable for a point
+ // number of points for a linestring
+ // number of rings for a polygon
+ // number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ size: u32,
+ // SRID if given buffer was EWKB. Otherwise, 0.
+ srid: u32,
+ // First x,y coordinates for a point. Otherwise (f64::NAN, f64::NAN) if
empty
+ first_xy: (f64, f64),
+ // Dimensions of the first nested geometry of a collection or None if empty
+ // For POINT, LINESTRING, POLYGON, returns the dimensions of the geometry
+ first_geom_dimensions: Option<Dimensions>,
+}
+
+impl WkbHeader {
+ /// Creates a new [WkbHeader] from a buffer
+ pub fn try_new(buf: &[u8]) -> Result<Self> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> try_new");
+ };
+
+ let byte_order = buf[0];
+
+ // Parse geometry type
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type &
0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ let mut i = 5;
+ let mut srid = 0;
+ // if EWKB
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ srid = match byte_order {
+ 0 => u32::from_be_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ 1 => u32::from_le_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
Review Comment:
This pattern is also repeated quite a few times and would benefit from a
function
##########
rust/sedona-geometry/src/wkb_header.rs:
##########
@@ -0,0 +1,728 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::types::GeometryTypeId;
+use datafusion_common::{
+ error::{DataFusionError, Result},
+ exec_err,
+};
+use geo_traits::Dimensions;
+use sedona_common::sedona_internal_err;
+
+const SRID_FLAG_BIT: u32 = 0x20000000;
+
+/// Fast-path WKB header parser
+/// Performs operations lazily and caches them after the first computation
+pub struct WkbHeader {
+ geometry_type: u32,
+ // Not applicable for a point
+ // number of points for a linestring
+ // number of rings for a polygon
+ // number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ size: u32,
+ // SRID if given buffer was EWKB. Otherwise, 0.
+ srid: u32,
+ // First x,y coordinates for a point. Otherwise (f64::NAN, f64::NAN) if
empty
+ first_xy: (f64, f64),
+ // Dimensions of the first nested geometry of a collection or None if empty
+ // For POINT, LINESTRING, POLYGON, returns the dimensions of the geometry
+ first_geom_dimensions: Option<Dimensions>,
Review Comment:
How about `first_sequence_geometry_type: u32`? (Slightly more in tune with
your existing pattern of storing raw data and calculating the value on request)
##########
rust/sedona-geometry/src/wkb_header.rs:
##########
@@ -0,0 +1,728 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::types::GeometryTypeId;
+use datafusion_common::{
+ error::{DataFusionError, Result},
+ exec_err,
+};
+use geo_traits::Dimensions;
+use sedona_common::sedona_internal_err;
+
+const SRID_FLAG_BIT: u32 = 0x20000000;
+
+/// Fast-path WKB header parser
+/// Performs operations lazily and caches them after the first computation
+pub struct WkbHeader {
+ geometry_type: u32,
+ // Not applicable for a point
+ // number of points for a linestring
+ // number of rings for a polygon
+ // number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ size: u32,
+ // SRID if given buffer was EWKB. Otherwise, 0.
+ srid: u32,
+ // First x,y coordinates for a point. Otherwise (f64::NAN, f64::NAN) if
empty
+ first_xy: (f64, f64),
+ // Dimensions of the first nested geometry of a collection or None if empty
+ // For POINT, LINESTRING, POLYGON, returns the dimensions of the geometry
+ first_geom_dimensions: Option<Dimensions>,
+}
+
+impl WkbHeader {
+ /// Creates a new [WkbHeader] from a buffer
+ pub fn try_new(buf: &[u8]) -> Result<Self> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> try_new");
+ };
+
+ let byte_order = buf[0];
+
+ // Parse geometry type
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type &
0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ let mut i = 5;
+ let mut srid = 0;
+ // if EWKB
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ srid = match byte_order {
+ 0 => u32::from_be_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ 1 => u32::from_le_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+ i = 9;
+ }
+
+ let size = if geometry_type_id == GeometryTypeId::Point {
+ // Dummy value for a point
+ 1
+ } else {
+ match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ }
+ };
+
+ // Default values for empty geometries
+ let first_x;
+ let first_y;
+ let first_geom_dimensions: Option<Dimensions>;
+
+ let first_geom_idx = first_geom_idx(buf)?;
+ if let Some(i) = first_geom_idx {
+ first_geom_dimensions = Some(parse_dimensions(&buf[i..])?);
+ (first_x, first_y) = first_xy(&buf[i..])?;
+ } else {
+ first_geom_dimensions = None;
+ first_x = f64::NAN;
+ first_y = f64::NAN;
+ }
+
+ Ok(Self {
+ geometry_type,
+ srid,
+ size,
+ first_xy: (first_x, first_y),
+ first_geom_dimensions,
+ })
+ }
+
+ /// Returns the geometry type id of the WKB by only parsing the header
instead of the entire WKB
+ /// 1 -> Point
+ /// 2 -> LineString
+ /// 3 -> Polygon
+ /// 4 -> MultiPoint
+ /// 5 -> MultiLineString
+ /// 6 -> MultiPolygon
+ /// 7 -> GeometryCollection
+ ///
+ /// Spec: https://libgeos.org/specifications/wkb/
+ pub fn geometry_type_id(&self) -> Result<GeometryTypeId> {
+ // Only low 3 bits is for the base type, high bits include additional
info
+ let code = self.geometry_type & 0x7;
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(code)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ Ok(geometry_type_id)
+ }
+
+ /// Returns the size of the geometry
+ /// Not applicable for a point
+ /// Number of points for a linestring
+ /// Number of rings for a polygon
+ /// Number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ pub fn size(&self) -> u32 {
+ self.size
+ }
+
+ /// Returns the SRID if given buffer was EWKB. Otherwise, 0.
+ pub fn srid(&self) -> u32 {
+ self.srid
+ }
+
+ /// Returns the first x, y coordinates for a point. Otherwise (f64::NAN,
f64::NAN) if empty
+ pub fn first_xy(&self) -> (f64, f64) {
+ self.first_xy
+ }
+
+ /// Returns the top-level dimension of the WKB
+ pub fn dimensions(&self) -> Result<Dimensions> {
+ let dimensions = match self.geometry_type / 1000 {
+ 0 => Dimensions::Xy,
+ 1 => Dimensions::Xyz,
+ 2 => Dimensions::Xym,
+ 3 => Dimensions::Xyzm,
+ _ => exec_err!("Unexpected code: {}", self.geometry_type)?,
+ };
+ Ok(dimensions)
Review Comment:
This also needs to handle the EWKB Z or M mask. This match exists in a few
places and would benefit from its own function.
##########
rust/sedona-geometry/src/wkb_header.rs:
##########
@@ -0,0 +1,728 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::types::GeometryTypeId;
+use datafusion_common::{
+ error::{DataFusionError, Result},
+ exec_err,
+};
+use geo_traits::Dimensions;
+use sedona_common::sedona_internal_err;
+
+const SRID_FLAG_BIT: u32 = 0x20000000;
+
+/// Fast-path WKB header parser
+/// Performs operations lazily and caches them after the first computation
+pub struct WkbHeader {
+ geometry_type: u32,
+ // Not applicable for a point
+ // number of points for a linestring
+ // number of rings for a polygon
+ // number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ size: u32,
+ // SRID if given buffer was EWKB. Otherwise, 0.
+ srid: u32,
+ // First x,y coordinates for a point. Otherwise (f64::NAN, f64::NAN) if
empty
+ first_xy: (f64, f64),
+ // Dimensions of the first nested geometry of a collection or None if empty
+ // For POINT, LINESTRING, POLYGON, returns the dimensions of the geometry
+ first_geom_dimensions: Option<Dimensions>,
+}
+
+impl WkbHeader {
+ /// Creates a new [WkbHeader] from a buffer
+ pub fn try_new(buf: &[u8]) -> Result<Self> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> try_new");
+ };
+
+ let byte_order = buf[0];
+
+ // Parse geometry type
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type &
0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ let mut i = 5;
+ let mut srid = 0;
+ // if EWKB
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ srid = match byte_order {
+ 0 => u32::from_be_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ 1 => u32::from_le_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+ i = 9;
+ }
+
+ let size = if geometry_type_id == GeometryTypeId::Point {
+ // Dummy value for a point
+ 1
+ } else {
+ match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ }
+ };
+
+ // Default values for empty geometries
+ let first_x;
+ let first_y;
+ let first_geom_dimensions: Option<Dimensions>;
+
+ let first_geom_idx = first_geom_idx(buf)?;
+ if let Some(i) = first_geom_idx {
+ first_geom_dimensions = Some(parse_dimensions(&buf[i..])?);
+ (first_x, first_y) = first_xy(&buf[i..])?;
+ } else {
+ first_geom_dimensions = None;
+ first_x = f64::NAN;
+ first_y = f64::NAN;
+ }
+
+ Ok(Self {
+ geometry_type,
+ srid,
+ size,
+ first_xy: (first_x, first_y),
+ first_geom_dimensions,
+ })
+ }
+
+ /// Returns the geometry type id of the WKB by only parsing the header
instead of the entire WKB
+ /// 1 -> Point
+ /// 2 -> LineString
+ /// 3 -> Polygon
+ /// 4 -> MultiPoint
+ /// 5 -> MultiLineString
+ /// 6 -> MultiPolygon
+ /// 7 -> GeometryCollection
+ ///
+ /// Spec: https://libgeos.org/specifications/wkb/
+ pub fn geometry_type_id(&self) -> Result<GeometryTypeId> {
+ // Only low 3 bits is for the base type, high bits include additional
info
+ let code = self.geometry_type & 0x7;
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(code)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ Ok(geometry_type_id)
+ }
+
+ /// Returns the size of the geometry
+ /// Not applicable for a point
+ /// Number of points for a linestring
+ /// Number of rings for a polygon
+ /// Number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ pub fn size(&self) -> u32 {
+ self.size
+ }
+
+ /// Returns the SRID if given buffer was EWKB. Otherwise, 0.
+ pub fn srid(&self) -> u32 {
+ self.srid
+ }
+
+ /// Returns the first x, y coordinates for a point. Otherwise (f64::NAN,
f64::NAN) if empty
+ pub fn first_xy(&self) -> (f64, f64) {
+ self.first_xy
+ }
+
+ /// Returns the top-level dimension of the WKB
+ pub fn dimensions(&self) -> Result<Dimensions> {
+ let dimensions = match self.geometry_type / 1000 {
+ 0 => Dimensions::Xy,
+ 1 => Dimensions::Xyz,
+ 2 => Dimensions::Xym,
+ 3 => Dimensions::Xyzm,
+ _ => exec_err!("Unexpected code: {}", self.geometry_type)?,
+ };
+ Ok(dimensions)
+ }
+
+ /// Returns the dimensions of the first coordinate of the geometry
+ pub fn first_geom_dimensions(&self) -> Option<Dimensions> {
+ self.first_geom_dimensions
+ }
+}
+
+// For MULITPOINT, MULTILINESTRING, MULTIPOLYGON, or GEOMETRYCOLLECTION,
returns the index to the first nested
+// non-collection geometry (POINT, LINESTRING, or POLYGON), or None if empty
+// For POINT, LINESTRING, POLYGON, returns 0 as it already is a non-collection
geometry
+fn first_geom_idx(buf: &[u8]) -> Result<Option<usize>> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> first_geom_idx");
+ }
+
+ let byte_order = buf[0];
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order: {other}"),
+ };
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type & 0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ match geometry_type_id {
+ GeometryTypeId::Point | GeometryTypeId::LineString |
GeometryTypeId::Polygon => Ok(Some(0)),
+ GeometryTypeId::MultiPoint
+ | GeometryTypeId::MultiLineString
+ | GeometryTypeId::MultiPolygon
+ | GeometryTypeId::GeometryCollection => {
+ if buf.len() < 9 {
+ exec_err!("Invalid WKB: buffer too small")?
+ }
+ let num_geometries = match byte_order {
+ 0 => u32::from_be_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ 1 => u32::from_le_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ if num_geometries == 0 {
+ return Ok(None);
+ }
+
+ let mut i = 9;
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ i += 4;
+ }
+
+ // Recursive call to get the first geom of the first nested
geometry
+ // Add to current offset of i
+ let off = first_geom_idx(&buf[i..]);
+ if let Ok(Some(off)) = off {
+ Ok(Some(i + off))
+ } else {
+ Ok(None)
+ }
+ }
+ _ => sedona_internal_err!("Unexpected geometry type:
{geometry_type_id:?}"),
+ }
+}
+
+// Given a point, linestring, or polygon, return the first xy coordinate
+// If the geometry, is empty, (NaN, NaN) is returned
+fn first_xy(buf: &[u8]) -> Result<(f64, f64)> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> first_xy");
+ }
+
+ let byte_order = buf[0];
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order: {other}"),
+ };
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type & 0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ // 1 (byte_order) + 4 (geometry_type) = 5
+ let mut i = 5;
+
+ // Skip the SRID if it's present
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ i += 4;
+ }
+
+ if matches!(
+ geometry_type_id,
+ GeometryTypeId::LineString | GeometryTypeId::Polygon
+ ) {
+ if buf.len() < i + 4 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> first_xy3 {} is not < {}",
+ buf.len(),
+ i + 4
+ );
+ }
+ let size = match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i +
3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i +
3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ // (NaN, NaN) for empty geometries
+ if size == 0 {
+ return Ok((f64::NAN, f64::NAN));
+ }
+ // + 4 for size
+ i += 4;
+
+ // For POLYGON, after the number of rings, the next 4 bytes are the
+ // number of points in the exterior ring. We must skip that count to
+ // land on the first coordinate's x value.
+ if geometry_type_id == GeometryTypeId::Polygon {
+ if buf.len() < i + 4 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> polygon first ring size
{} is not < {}",
+ buf.len(),
+ i + 4
+ );
+ }
+ let ring0_num_points = match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ // (NaN, NaN) for empty first ring
+ if ring0_num_points == 0 {
+ return Ok((f64::NAN, f64::NAN));
+ }
+ i += 4;
+ }
+ }
+
+ if buf.len() < i + 8 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> first_xy4 {} is not < {}",
+ i + 8,
+ buf.len()
+ );
+ }
+ let x = parse_coord(&buf[i..], byte_order)?;
+ let y = parse_coord(&buf[i + 8..], byte_order)?;
+ Ok((x, y))
+}
+
+// Given a buffer starting at the coordinate itself, parse the x and y
coordinates
+fn parse_coord(buf: &[u8], byte_order: u8) -> Result<f64> {
+ if buf.len() < 8 {
+ return exec_err!("Invalid WKB: buffer too small -> parse_coord");
+ }
+
+ let coord: f64 = match byte_order {
+ 0 => f64::from_be_bytes([
+ buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], buf[7],
+ ]),
+ 1 => f64::from_le_bytes([
+ buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], buf[7],
+ ]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}")?,
+ };
+
+ Ok(coord)
+}
+
+// Parses the top-level dimension of the geometry
+fn parse_dimensions(buf: &[u8]) -> Result<Dimensions> {
+ if buf.len() < 9 {
+ return exec_err!("Invalid WKB: buffer too small -> parse_dimensions");
+ }
+
+ let byte_order = buf[0];
+
+ let code = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => sedona_internal_err!("Unexpected byte order: {other}")?,
+ };
+
+ match code / 1000 {
+ 0 => Ok(Dimensions::Xy),
+ 1 => Ok(Dimensions::Xyz),
+ 2 => Ok(Dimensions::Xym),
+ 3 => Ok(Dimensions::Xyzm),
+ _ => exec_err!("Unexpected code: {code:?}"),
+ }
+}
+
Review Comment:
There is a lot of code here that is bookkeeping and byte swapping as you
walk the buffer and a number of those elements are repeated. The part that
makes this complicated is the collection part where you need to parse until the
first sequence (otherwise you would just be copying the first few bytes of the
buffer).
Many parsers manage abstracting that repetition with something like this:
```rust
struct WkbBuffer {
buf: &[u8],
offset: usize,
remaining: usize,
last_endian: u8
}
impl WkbBuffer {
pub fn read_endian(&mut self) -> Result<()> {
if self.remaining < 1 {
return Err(...)
}
self.last_endian = buf[self.offset];
self.remaining -= 1;
self.offset += 1;
Ok(())
}
pub fn read_u32(&mut self) -> Result<u32> {
if self.remaining < 4 {
return Err(...)
}
let out = match self.last_endian { ... }
self.remaining -= 4;
self.offset += 4;
Ok(out)
}
}
```
##########
rust/sedona-geometry/src/wkb_header.rs:
##########
@@ -0,0 +1,728 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::types::GeometryTypeId;
+use datafusion_common::{
+ error::{DataFusionError, Result},
+ exec_err,
+};
+use geo_traits::Dimensions;
+use sedona_common::sedona_internal_err;
+
+const SRID_FLAG_BIT: u32 = 0x20000000;
+
+/// Fast-path WKB header parser
+/// Performs operations lazily and caches them after the first computation
+pub struct WkbHeader {
+ geometry_type: u32,
+ // Not applicable for a point
+ // number of points for a linestring
+ // number of rings for a polygon
+ // number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ size: u32,
+ // SRID if given buffer was EWKB. Otherwise, 0.
+ srid: u32,
+ // First x,y coordinates for a point. Otherwise (f64::NAN, f64::NAN) if
empty
+ first_xy: (f64, f64),
+ // Dimensions of the first nested geometry of a collection or None if empty
+ // For POINT, LINESTRING, POLYGON, returns the dimensions of the geometry
+ first_geom_dimensions: Option<Dimensions>,
+}
+
+impl WkbHeader {
+ /// Creates a new [WkbHeader] from a buffer
+ pub fn try_new(buf: &[u8]) -> Result<Self> {
+ if buf.len() < 5 {
+ return sedona_internal_err!("Invalid WKB: buffer too small ->
try_new");
+ };
+
+ let byte_order = buf[0];
+
+ // Parse geometry type
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type &
0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ let mut i = 5;
+ let mut srid = 0;
+ // if EWKB
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ srid = match byte_order {
+ 0 => u32::from_be_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ 1 => u32::from_le_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+ i = 9;
+ }
+
+ let size = if geometry_type_id == GeometryTypeId::Point {
+ // Dummy value for a point
+ 1
+ } else {
+ match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ }
+ };
+
+ // Default values for empty geometries
+ let first_x;
+ let first_y;
+ let first_geom_dimensions: Option<Dimensions>;
+
+ let first_geom_idx = first_geom_idx(buf)?;
+ if let Some(i) = first_geom_idx {
+ first_geom_dimensions = Some(parse_dimensions(&buf[i..])?);
+ (first_x, first_y) = first_xy(&buf[i..])?;
+ } else {
+ first_geom_dimensions = None;
+ first_x = f64::NAN;
+ first_y = f64::NAN;
+ }
+
+ Ok(Self {
+ geometry_type,
+ srid,
+ size,
+ first_xy: (first_x, first_y),
+ first_geom_dimensions,
+ })
+ }
+
+ /// Returns the geometry type id of the WKB by only parsing the header
instead of the entire WKB
+ /// 1 -> Point
+ /// 2 -> LineString
+ /// 3 -> Polygon
+ /// 4 -> MultiPoint
+ /// 5 -> MultiLineString
+ /// 6 -> MultiPolygon
+ /// 7 -> GeometryCollection
+ ///
+ /// Spec: https://libgeos.org/specifications/wkb/
+ pub fn geometry_type_id(&self) -> Result<GeometryTypeId> {
+ // Only low 3 bits is for the base type, high bits include additional
info
+ let code = self.geometry_type & 0x7;
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(code)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ Ok(geometry_type_id)
+ }
+
+ /// Returns the size of the geometry
+ /// Not applicable for a point
+ /// Number of points for a linestring
+ /// Number of rings for a polygon
+ /// Number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ pub fn size(&self) -> u32 {
+ self.size
+ }
+
+ /// Returns the SRID if given buffer was EWKB. Otherwise, 0.
+ pub fn srid(&self) -> u32 {
+ self.srid
+ }
+
+ /// Returns the first x, y coordinates for a point. Otherwise (f64::NAN,
f64::NAN) if empty
+ pub fn first_xy(&self) -> (f64, f64) {
+ self.first_xy
+ }
+
+ /// Returns the top-level dimension of the WKB
+ pub fn dimensions(&self) -> Result<Dimensions> {
+ let dimensions = match self.geometry_type / 1000 {
+ 0 => Dimensions::Xy,
+ 1 => Dimensions::Xyz,
+ 2 => Dimensions::Xym,
+ 3 => Dimensions::Xyzm,
+ _ => sedona_internal_err!("Unexpected code: {}",
self.geometry_type)?,
+ };
+ Ok(dimensions)
+ }
+
+ /// Returns the dimensions of the first coordinate of the geometry
+ pub fn first_geom_dimensions(&self) -> Option<Dimensions> {
+ self.first_geom_dimensions
+ }
+}
+
+// For MULITPOINT, MULTILINESTRING, MULTIPOLYGON, or GEOMETRYCOLLECTION,
returns the index to the first nested
+// non-collection geometry (POINT, LINESTRING, or POLYGON), or None if empty
+// For POINT, LINESTRING, POLYGON, returns 0 as it already is a non-collection
geometry
+fn first_geom_idx(buf: &[u8]) -> Result<Option<usize>> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> first_geom_idx");
+ }
+
+ let byte_order = buf[0];
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order: {other}"),
+ };
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type & 0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ match geometry_type_id {
+ GeometryTypeId::Point | GeometryTypeId::LineString |
GeometryTypeId::Polygon => Ok(Some(0)),
+ GeometryTypeId::MultiPoint
+ | GeometryTypeId::MultiLineString
+ | GeometryTypeId::MultiPolygon
+ | GeometryTypeId::GeometryCollection => {
+ if buf.len() < 9 {
+ exec_err!("Invalid WKB: buffer too small")?
+ }
+ let num_geometries = match byte_order {
+ 0 => u32::from_be_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ 1 => u32::from_le_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ if num_geometries == 0 {
+ return Ok(None);
+ }
+
+ let mut i = 9;
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ i += 4;
+ }
+
+ // Recursive call to get the first geom of the first nested
geometry
+ // Add to current offset of i
+ let off = first_geom_idx(&buf[i..]);
+ if let Ok(Some(off)) = off {
+ Ok(Some(i + off))
+ } else {
+ Ok(None)
+ }
+ }
+ _ => sedona_internal_err!("Unexpected geometry type:
{geometry_type_id:?}"),
+ }
+}
+
+// Given a point, linestring, or polygon, return the first xy coordinate
+// If the geometry, is empty, (NaN, NaN) is returned
+fn first_xy(buf: &[u8]) -> Result<(f64, f64)> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> first_xy");
+ }
+
+ let byte_order = buf[0];
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order: {other}"),
+ };
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type & 0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ // 1 (byte_order) + 4 (geometry_type) = 5
+ let mut i = 5;
+
+ // Skip the SRID if it's present
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ i += 4;
+ }
+
+ if matches!(
+ geometry_type_id,
+ GeometryTypeId::LineString | GeometryTypeId::Polygon
+ ) {
+ if buf.len() < i + 4 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> first_xy3 {} is not < {}",
+ buf.len(),
+ i + 4
+ );
+ }
+ let size = match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i +
3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i +
3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ // (NaN, NaN) for empty geometries
+ if size == 0 {
+ return Ok((f64::NAN, f64::NAN));
+ }
+ // + 4 for size
+ i += 4;
+
+ // For POLYGON, after the number of rings, the next 4 bytes are the
+ // number of points in the exterior ring. We must skip that count to
+ // land on the first coordinate's x value.
+ if geometry_type_id == GeometryTypeId::Polygon {
+ if buf.len() < i + 4 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> polygon first ring size
{} is not < {}",
+ buf.len(),
+ i + 4
+ );
+ }
+ let ring0_num_points = match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ // (NaN, NaN) for empty first ring
+ if ring0_num_points == 0 {
+ return Ok((f64::NAN, f64::NAN));
+ }
+ i += 4;
+ }
+ }
+
+ if buf.len() < i + 8 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> first_xy4 {} is not < {}",
+ i + 8,
+ buf.len()
+ );
+ }
+ let x = parse_coord(&buf[i..], byte_order)?;
+ let y = parse_coord(&buf[i + 8..], byte_order)?;
+ Ok((x, y))
+}
+
+// Given a buffer starting at the coordinate itself, parse the x and y
coordinates
+fn parse_coord(buf: &[u8], byte_order: u8) -> Result<f64> {
+ if buf.len() < 8 {
+ return sedona_internal_err!("Invalid WKB: buffer too small ->
parse_coord");
+ }
+
+ let coord: f64 = match byte_order {
+ 0 => f64::from_be_bytes([
+ buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], buf[7],
+ ]),
+ 1 => f64::from_le_bytes([
+ buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], buf[7],
+ ]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}")?,
+ };
+
+ Ok(coord)
+}
+
+// Parses the top-level dimension of the geometry
+fn parse_dimensions(buf: &[u8]) -> Result<Dimensions> {
+ if buf.len() < 9 {
+ return sedona_internal_err!("Invalid WKB: buffer too small ->
parse_dimensions");
+ }
+
+ let byte_order = buf[0];
+
+ let code = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => sedona_internal_err!("Unexpected byte order: {other}")?,
+ };
+
+ match code / 1000 {
+ 0 => Ok(Dimensions::Xy),
+ 1 => Ok(Dimensions::Xyz),
+ 2 => Ok(Dimensions::Xym),
+ 3 => Ok(Dimensions::Xyzm),
+ _ => sedona_internal_err!("Unexpected code: {code:?}"),
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use std::str::FromStr;
+ use wkt::Wkt;
+
+ fn make_wkb(wkt_value: &'static str) -> Vec<u8> {
+ let geom = Wkt::<f64>::from_str(wkt_value).unwrap();
+ let mut buf: Vec<u8> = vec![];
+ wkb::writer::write_geometry(&mut buf, &geom,
Default::default()).unwrap();
+ buf
+ }
+
+ #[test]
+ fn geometry_type_id() {
+ let wkb = make_wkb("POINT (1 2)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("LINESTRING (1 2, 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::LineString
+ );
+
+ let wkb = make_wkb("POLYGON ((0 0, 0 1, 1 0, 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(),
GeometryTypeId::Polygon);
+
+ let wkb = make_wkb("MULTIPOINT ((1 2), (3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiPoint
+ );
+
+ let wkb = make_wkb("MULTILINESTRING ((1 2, 3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiLineString
+ );
+
+ let wkb = make_wkb("MULTIPOLYGON (((0 0, 0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiPolygon
+ );
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::GeometryCollection
+ );
+
+ // Some cases with z and m dimensions
+ let wkb = make_wkb("POINT Z (1 2 3)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("LINESTRING Z (1 2 3, 4 5 6)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::LineString
+ );
+
+ let wkb = make_wkb("POLYGON M ((0 0 0, 0 1 0, 1 0 0, 0 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(),
GeometryTypeId::Polygon);
+ }
+
+ #[test]
+ fn size() {
+ let wkb = make_wkb("LINESTRING (1 2, 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("POLYGON ((0 0, 0 1, 1 0, 0 0), (1 1, 1 2, 2 1, 1
1))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("MULTIPOINT ((1 2), (3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("MULTILINESTRING ((1 2, 3 4, 5 6), (7 8, 9 10, 11
12))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("MULTIPOLYGON (((0 0, 0 1, 1 0, 0 0)), ((1 1, 1 2,
2 1, 1 1)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 1);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2), LINESTRING (1 2,
3 4), POLYGON ((0 0, 0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 3);
+ }
+
+ #[test]
+ fn empty_size() {
+ let wkb = make_wkb("LINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("POLYGON EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("MULTIPOINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("MULTILINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("MULTIPOLYGON EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+ }
+
+ // #[test]
+ // fn srid() {
+ // // This doesn't work
+ // let wkb = make_wkb("SRID=4326;POINT (1 2)");
+ // println!("wkb: {:?}", wkb);
+ // let header = WkbHeader::try_new(&wkb).unwrap();
+ // assert_eq!(header.srid(), 4326);
+ // }
Review Comment:
It did...thanks for the ping!
I use R's wk package to generate these (long ago I wrote EKWT parsing and
EWKB writing as a default, which was not a good idea in retrospect, but has
proved very useful for generating test data). You can do this yourself or use
these as fixtures (I think these are all the ones you'll need):
``` r
wk::as_wkb("SRID=4326;POINT (1 2)") |> dput()
#> structure(list(as.raw(c(0x01, 0x01, 0x00, 0x00, 0x20, 0xe6, 0x10,
#> 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf0, 0x3f, 0x00,
#> 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40))), class = c("wk_wkb",
#> "wk_vctr"))
wk::as_wkb("SRID=4326;POINT Z (1 2 3)") |> dput()
#> structure(list(as.raw(c(0x01, 0x01, 0x00, 0x00, 0xa0, 0xe6, 0x10,
#> 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf0, 0x3f, 0x00,
#> 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x00,
#> 0x00, 0x00, 0x08, 0x40))), class = c("wk_wkb", "wk_vctr"))
wk::as_wkb("SRID=4326;POINT M (1 2 4)") |> dput()
#> structure(list(as.raw(c(0x01, 0x01, 0x00, 0x00, 0x60, 0xe6, 0x10,
#> 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf0, 0x3f, 0x00,
#> 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x00,
#> 0x00, 0x00, 0x10, 0x40))), class = c("wk_wkb", "wk_vctr"))
wk::as_wkb("SRID=4326;POINT ZM (1 2 3 4)") |> dput()
#> structure(list(as.raw(c(0x01, 0x01, 0x00, 0x00, 0xe0, 0xe6, 0x10,
#> 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf0, 0x3f, 0x00,
#> 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x00,
#> 0x00, 0x00, 0x08, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10,
#> 0x40))), class = c("wk_wkb", "wk_vctr"))
wk::as_wkb("SRID=4326;GEOMETRYCOLLECTION (POINT (1 2))") |> dput()
#> structure(list(as.raw(c(0x01, 0x07, 0x00, 0x00, 0x20, 0xe6, 0x10,
#> 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x01, 0x00, 0x00, 0x00,
#> 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf0, 0x3f, 0x00, 0x00, 0x00,
#> 0x00, 0x00, 0x00, 0x00, 0x40))), class = c("wk_wkb", "wk_vctr"
#> ))
wk::as_wkb("SRID=4326;GEOMETRYCOLLECTION (POINT Z (1 2 3))") |> dput()
#> structure(list(as.raw(c(0x01, 0x07, 0x00, 0x00, 0x20, 0xe6, 0x10,
#> 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x01, 0x00, 0x00, 0x80,
#> 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf0, 0x3f, 0x00, 0x00, 0x00,
#> 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
#> 0x08, 0x40))), class = c("wk_wkb", "wk_vctr"))
wk::as_wkb("SRID=4326;GEOMETRYCOLLECTION (POINT M (1 2 4))") |> dput()
#> structure(list(as.raw(c(0x01, 0x07, 0x00, 0x00, 0x20, 0xe6, 0x10,
#> 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x01, 0x00, 0x00, 0x40,
#> 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf0, 0x3f, 0x00, 0x00, 0x00,
#> 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
#> 0x10, 0x40))), class = c("wk_wkb", "wk_vctr"))
wk::as_wkb("SRID=4326;GEOMETRYCOLLECTION (POINT ZM (1 2 3 4))") |> dput()
#> structure(list(as.raw(c(0x01, 0x07, 0x00, 0x00, 0x20, 0xe6, 0x10,
#> 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x01, 0x00, 0x00, 0xc0,
#> 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xf0, 0x3f, 0x00, 0x00, 0x00,
#> 0x00, 0x00, 0x00, 0x00, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
#> 0x08, 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x40))), class =
c("wk_wkb",
#> "wk_vctr"))
```
##########
rust/sedona-geometry/src/wkb_header.rs:
##########
@@ -0,0 +1,728 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::types::GeometryTypeId;
+use datafusion_common::{
+ error::{DataFusionError, Result},
+ exec_err,
+};
+use geo_traits::Dimensions;
+use sedona_common::sedona_internal_err;
+
+const SRID_FLAG_BIT: u32 = 0x20000000;
+
+/// Fast-path WKB header parser
+/// Performs operations lazily and caches them after the first computation
+pub struct WkbHeader {
+ geometry_type: u32,
+ // Not applicable for a point
+ // number of points for a linestring
+ // number of rings for a polygon
+ // number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ size: u32,
+ // SRID if given buffer was EWKB. Otherwise, 0.
+ srid: u32,
+ // First x,y coordinates for a point. Otherwise (f64::NAN, f64::NAN) if
empty
+ first_xy: (f64, f64),
+ // Dimensions of the first nested geometry of a collection or None if empty
+ // For POINT, LINESTRING, POLYGON, returns the dimensions of the geometry
+ first_geom_dimensions: Option<Dimensions>,
+}
+
+impl WkbHeader {
+ /// Creates a new [WkbHeader] from a buffer
+ pub fn try_new(buf: &[u8]) -> Result<Self> {
+ if buf.len() < 5 {
+ return sedona_internal_err!("Invalid WKB: buffer too small ->
try_new");
+ };
+
+ let byte_order = buf[0];
+
+ // Parse geometry type
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type &
0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ let mut i = 5;
+ let mut srid = 0;
+ // if EWKB
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ srid = match byte_order {
+ 0 => u32::from_be_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ 1 => u32::from_le_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+ i = 9;
+ }
+
+ let size = if geometry_type_id == GeometryTypeId::Point {
+ // Dummy value for a point
+ 1
+ } else {
+ match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ }
+ };
+
+ // Default values for empty geometries
+ let first_x;
+ let first_y;
+ let first_geom_dimensions: Option<Dimensions>;
+
+ let first_geom_idx = first_geom_idx(buf)?;
+ if let Some(i) = first_geom_idx {
+ first_geom_dimensions = Some(parse_dimensions(&buf[i..])?);
+ (first_x, first_y) = first_xy(&buf[i..])?;
+ } else {
+ first_geom_dimensions = None;
+ first_x = f64::NAN;
+ first_y = f64::NAN;
+ }
+
+ Ok(Self {
+ geometry_type,
+ srid,
+ size,
+ first_xy: (first_x, first_y),
+ first_geom_dimensions,
+ })
+ }
+
+ /// Returns the geometry type id of the WKB by only parsing the header
instead of the entire WKB
+ /// 1 -> Point
+ /// 2 -> LineString
+ /// 3 -> Polygon
+ /// 4 -> MultiPoint
+ /// 5 -> MultiLineString
+ /// 6 -> MultiPolygon
+ /// 7 -> GeometryCollection
+ ///
+ /// Spec: https://libgeos.org/specifications/wkb/
+ pub fn geometry_type_id(&self) -> Result<GeometryTypeId> {
+ // Only low 3 bits is for the base type, high bits include additional
info
+ let code = self.geometry_type & 0x7;
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(code)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ Ok(geometry_type_id)
+ }
+
+ /// Returns the size of the geometry
+ /// Not applicable for a point
+ /// Number of points for a linestring
+ /// Number of rings for a polygon
+ /// Number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ pub fn size(&self) -> u32 {
+ self.size
+ }
+
+ /// Returns the SRID if given buffer was EWKB. Otherwise, 0.
+ pub fn srid(&self) -> u32 {
+ self.srid
+ }
+
+ /// Returns the first x, y coordinates for a point. Otherwise (f64::NAN,
f64::NAN) if empty
+ pub fn first_xy(&self) -> (f64, f64) {
+ self.first_xy
+ }
+
+ /// Returns the top-level dimension of the WKB
+ pub fn dimensions(&self) -> Result<Dimensions> {
+ let dimensions = match self.geometry_type / 1000 {
+ 0 => Dimensions::Xy,
+ 1 => Dimensions::Xyz,
+ 2 => Dimensions::Xym,
+ 3 => Dimensions::Xyzm,
+ _ => sedona_internal_err!("Unexpected code: {}",
self.geometry_type)?,
+ };
+ Ok(dimensions)
+ }
+
+ /// Returns the dimensions of the first coordinate of the geometry
+ pub fn first_geom_dimensions(&self) -> Option<Dimensions> {
+ self.first_geom_dimensions
+ }
+}
+
+// For MULITPOINT, MULTILINESTRING, MULTIPOLYGON, or GEOMETRYCOLLECTION,
returns the index to the first nested
+// non-collection geometry (POINT, LINESTRING, or POLYGON), or None if empty
+// For POINT, LINESTRING, POLYGON, returns 0 as it already is a non-collection
geometry
+fn first_geom_idx(buf: &[u8]) -> Result<Option<usize>> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> first_geom_idx");
+ }
+
+ let byte_order = buf[0];
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order: {other}"),
+ };
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type & 0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ match geometry_type_id {
+ GeometryTypeId::Point | GeometryTypeId::LineString |
GeometryTypeId::Polygon => Ok(Some(0)),
+ GeometryTypeId::MultiPoint
+ | GeometryTypeId::MultiLineString
+ | GeometryTypeId::MultiPolygon
+ | GeometryTypeId::GeometryCollection => {
+ if buf.len() < 9 {
+ exec_err!("Invalid WKB: buffer too small")?
+ }
+ let num_geometries = match byte_order {
+ 0 => u32::from_be_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ 1 => u32::from_le_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ if num_geometries == 0 {
+ return Ok(None);
+ }
+
+ let mut i = 9;
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ i += 4;
+ }
+
+ // Recursive call to get the first geom of the first nested
geometry
+ // Add to current offset of i
+ let off = first_geom_idx(&buf[i..]);
+ if let Ok(Some(off)) = off {
+ Ok(Some(i + off))
+ } else {
+ Ok(None)
+ }
+ }
+ _ => sedona_internal_err!("Unexpected geometry type:
{geometry_type_id:?}"),
+ }
+}
+
+// Given a point, linestring, or polygon, return the first xy coordinate
+// If the geometry, is empty, (NaN, NaN) is returned
+fn first_xy(buf: &[u8]) -> Result<(f64, f64)> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> first_xy");
+ }
+
+ let byte_order = buf[0];
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order: {other}"),
+ };
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type & 0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ // 1 (byte_order) + 4 (geometry_type) = 5
+ let mut i = 5;
+
+ // Skip the SRID if it's present
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ i += 4;
+ }
+
+ if matches!(
+ geometry_type_id,
+ GeometryTypeId::LineString | GeometryTypeId::Polygon
+ ) {
+ if buf.len() < i + 4 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> first_xy3 {} is not < {}",
+ buf.len(),
+ i + 4
+ );
+ }
+ let size = match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i +
3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i +
3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ // (NaN, NaN) for empty geometries
+ if size == 0 {
+ return Ok((f64::NAN, f64::NAN));
+ }
+ // + 4 for size
+ i += 4;
+
+ // For POLYGON, after the number of rings, the next 4 bytes are the
+ // number of points in the exterior ring. We must skip that count to
+ // land on the first coordinate's x value.
+ if geometry_type_id == GeometryTypeId::Polygon {
+ if buf.len() < i + 4 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> polygon first ring size
{} is not < {}",
+ buf.len(),
+ i + 4
+ );
+ }
+ let ring0_num_points = match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ // (NaN, NaN) for empty first ring
+ if ring0_num_points == 0 {
+ return Ok((f64::NAN, f64::NAN));
+ }
+ i += 4;
+ }
+ }
+
+ if buf.len() < i + 8 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> first_xy4 {} is not < {}",
+ i + 8,
+ buf.len()
+ );
+ }
+ let x = parse_coord(&buf[i..], byte_order)?;
+ let y = parse_coord(&buf[i + 8..], byte_order)?;
+ Ok((x, y))
+}
+
+// Given a buffer starting at the coordinate itself, parse the x and y
coordinates
+fn parse_coord(buf: &[u8], byte_order: u8) -> Result<f64> {
+ if buf.len() < 8 {
+ return sedona_internal_err!("Invalid WKB: buffer too small ->
parse_coord");
+ }
+
+ let coord: f64 = match byte_order {
+ 0 => f64::from_be_bytes([
+ buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], buf[7],
+ ]),
+ 1 => f64::from_le_bytes([
+ buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], buf[7],
+ ]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}")?,
+ };
+
+ Ok(coord)
+}
+
+// Parses the top-level dimension of the geometry
+fn parse_dimensions(buf: &[u8]) -> Result<Dimensions> {
+ if buf.len() < 9 {
+ return sedona_internal_err!("Invalid WKB: buffer too small ->
parse_dimensions");
+ }
+
+ let byte_order = buf[0];
+
+ let code = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => sedona_internal_err!("Unexpected byte order: {other}")?,
+ };
+
+ match code / 1000 {
+ 0 => Ok(Dimensions::Xy),
+ 1 => Ok(Dimensions::Xyz),
+ 2 => Ok(Dimensions::Xym),
+ 3 => Ok(Dimensions::Xyzm),
+ _ => sedona_internal_err!("Unexpected code: {code:?}"),
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use std::str::FromStr;
+ use wkt::Wkt;
+
+ fn make_wkb(wkt_value: &'static str) -> Vec<u8> {
+ let geom = Wkt::<f64>::from_str(wkt_value).unwrap();
+ let mut buf: Vec<u8> = vec![];
+ wkb::writer::write_geometry(&mut buf, &geom,
Default::default()).unwrap();
+ buf
+ }
+
+ #[test]
+ fn geometry_type_id() {
+ let wkb = make_wkb("POINT (1 2)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("LINESTRING (1 2, 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::LineString
+ );
+
+ let wkb = make_wkb("POLYGON ((0 0, 0 1, 1 0, 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(),
GeometryTypeId::Polygon);
+
+ let wkb = make_wkb("MULTIPOINT ((1 2), (3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiPoint
+ );
+
+ let wkb = make_wkb("MULTILINESTRING ((1 2, 3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiLineString
+ );
+
+ let wkb = make_wkb("MULTIPOLYGON (((0 0, 0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiPolygon
+ );
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::GeometryCollection
+ );
+
+ // Some cases with z and m dimensions
+ let wkb = make_wkb("POINT Z (1 2 3)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("LINESTRING Z (1 2 3, 4 5 6)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::LineString
+ );
+
+ let wkb = make_wkb("POLYGON M ((0 0 0, 0 1 0, 1 0 0, 0 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(),
GeometryTypeId::Polygon);
+ }
+
+ #[test]
+ fn size() {
+ let wkb = make_wkb("LINESTRING (1 2, 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("POLYGON ((0 0, 0 1, 1 0, 0 0), (1 1, 1 2, 2 1, 1
1))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("MULTIPOINT ((1 2), (3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("MULTILINESTRING ((1 2, 3 4, 5 6), (7 8, 9 10, 11
12))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("MULTIPOLYGON (((0 0, 0 1, 1 0, 0 0)), ((1 1, 1 2,
2 1, 1 1)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 1);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2), LINESTRING (1 2,
3 4), POLYGON ((0 0, 0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 3);
+ }
+
+ #[test]
+ fn empty_size() {
+ let wkb = make_wkb("LINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("POLYGON EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("MULTIPOINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("MULTILINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("MULTIPOLYGON EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+ }
+
+ // #[test]
+ // fn srid() {
+ // // This doesn't work
+ // let wkb = make_wkb("SRID=4326;POINT (1 2)");
+ // println!("wkb: {:?}", wkb);
+ // let header = WkbHeader::try_new(&wkb).unwrap();
+ // assert_eq!(header.srid(), 4326);
+ // }
+
+ #[test]
+ fn first_xy() {
+ let wkb = make_wkb("POINT (-5 -2)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (-5.0, -2.0));
+
+ let wkb = make_wkb("LINESTRING (1 2, 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.0, 2.0));
+
+ let wkb = make_wkb("POLYGON ((0 0, 0 1, 1 0, 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (0.0, 0.0));
+
+ // Another polygon test since that logic is more complicated
+ let wkb = make_wkb("POLYGON ((1.5 0.5, 1.5 1.5, 1.5 0.5), (0 0, 0 1, 1
0, 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.5, 0.5));
+
+ let wkb = make_wkb("MULTIPOINT ((1 2), (3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.0, 2.0));
+
+ let wkb = make_wkb("MULTILINESTRING ((3 4, 1 2), (5 6, 7 8))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (3.0, 4.0));
+
+ let wkb = make_wkb("MULTIPOLYGON (((-1 -1, 0 1, 1 -1, -1 -1)), ((0 0,
0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (-1.0, -1.0));
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.0, 2.0));
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2), LINESTRING (1 2,
3 4), POLYGON ((0 0, 0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.0, 2.0));
+ }
+
+ #[test]
+ fn empty_first_xy() {
Review Comment:
I think that works!
##########
rust/sedona-geometry/src/wkb_header.rs:
##########
@@ -0,0 +1,728 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::types::GeometryTypeId;
+use datafusion_common::{
+ error::{DataFusionError, Result},
+ exec_err,
+};
+use geo_traits::Dimensions;
+use sedona_common::sedona_internal_err;
+
+const SRID_FLAG_BIT: u32 = 0x20000000;
+
+/// Fast-path WKB header parser
+/// Performs operations lazily and caches them after the first computation
+pub struct WkbHeader {
+ geometry_type: u32,
+ // Not applicable for a point
+ // number of points for a linestring
+ // number of rings for a polygon
+ // number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ size: u32,
+ // SRID if given buffer was EWKB. Otherwise, 0.
+ srid: u32,
+ // First x,y coordinates for a point. Otherwise (f64::NAN, f64::NAN) if
empty
+ first_xy: (f64, f64),
+ // Dimensions of the first nested geometry of a collection or None if empty
+ // For POINT, LINESTRING, POLYGON, returns the dimensions of the geometry
+ first_geom_dimensions: Option<Dimensions>,
+}
+
+impl WkbHeader {
+ /// Creates a new [WkbHeader] from a buffer
+ pub fn try_new(buf: &[u8]) -> Result<Self> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> try_new");
+ };
+
+ let byte_order = buf[0];
+
+ // Parse geometry type
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type &
0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ let mut i = 5;
+ let mut srid = 0;
+ // if EWKB
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ srid = match byte_order {
+ 0 => u32::from_be_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ 1 => u32::from_le_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+ i = 9;
+ }
+
+ let size = if geometry_type_id == GeometryTypeId::Point {
+ // Dummy value for a point
+ 1
+ } else {
+ match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ }
+ };
+
+ // Default values for empty geometries
+ let first_x;
+ let first_y;
+ let first_geom_dimensions: Option<Dimensions>;
+
+ let first_geom_idx = first_geom_idx(buf)?;
+ if let Some(i) = first_geom_idx {
+ first_geom_dimensions = Some(parse_dimensions(&buf[i..])?);
+ (first_x, first_y) = first_xy(&buf[i..])?;
+ } else {
+ first_geom_dimensions = None;
+ first_x = f64::NAN;
+ first_y = f64::NAN;
+ }
+
+ Ok(Self {
+ geometry_type,
+ srid,
+ size,
+ first_xy: (first_x, first_y),
+ first_geom_dimensions,
+ })
+ }
+
+ /// Returns the geometry type id of the WKB by only parsing the header
instead of the entire WKB
+ /// 1 -> Point
+ /// 2 -> LineString
+ /// 3 -> Polygon
+ /// 4 -> MultiPoint
+ /// 5 -> MultiLineString
+ /// 6 -> MultiPolygon
+ /// 7 -> GeometryCollection
+ ///
+ /// Spec: https://libgeos.org/specifications/wkb/
+ pub fn geometry_type_id(&self) -> Result<GeometryTypeId> {
+ // Only low 3 bits is for the base type, high bits include additional
info
+ let code = self.geometry_type & 0x7;
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(code)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ Ok(geometry_type_id)
+ }
+
+ /// Returns the size of the geometry
+ /// Not applicable for a point
+ /// Number of points for a linestring
+ /// Number of rings for a polygon
+ /// Number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ pub fn size(&self) -> u32 {
+ self.size
+ }
+
+ /// Returns the SRID if given buffer was EWKB. Otherwise, 0.
+ pub fn srid(&self) -> u32 {
+ self.srid
+ }
+
+ /// Returns the first x, y coordinates for a point. Otherwise (f64::NAN,
f64::NAN) if empty
+ pub fn first_xy(&self) -> (f64, f64) {
+ self.first_xy
+ }
+
+ /// Returns the top-level dimension of the WKB
+ pub fn dimensions(&self) -> Result<Dimensions> {
+ let dimensions = match self.geometry_type / 1000 {
+ 0 => Dimensions::Xy,
+ 1 => Dimensions::Xyz,
+ 2 => Dimensions::Xym,
+ 3 => Dimensions::Xyzm,
+ _ => exec_err!("Unexpected code: {}", self.geometry_type)?,
+ };
+ Ok(dimensions)
+ }
+
+ /// Returns the dimensions of the first coordinate of the geometry
+ pub fn first_geom_dimensions(&self) -> Option<Dimensions> {
+ self.first_geom_dimensions
+ }
+}
+
+// For MULITPOINT, MULTILINESTRING, MULTIPOLYGON, or GEOMETRYCOLLECTION,
returns the index to the first nested
+// non-collection geometry (POINT, LINESTRING, or POLYGON), or None if empty
+// For POINT, LINESTRING, POLYGON, returns 0 as it already is a non-collection
geometry
+fn first_geom_idx(buf: &[u8]) -> Result<Option<usize>> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> first_geom_idx");
+ }
+
+ let byte_order = buf[0];
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order: {other}"),
+ };
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type & 0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ match geometry_type_id {
+ GeometryTypeId::Point | GeometryTypeId::LineString |
GeometryTypeId::Polygon => Ok(Some(0)),
+ GeometryTypeId::MultiPoint
+ | GeometryTypeId::MultiLineString
+ | GeometryTypeId::MultiPolygon
+ | GeometryTypeId::GeometryCollection => {
+ if buf.len() < 9 {
+ exec_err!("Invalid WKB: buffer too small")?
+ }
+ let num_geometries = match byte_order {
+ 0 => u32::from_be_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ 1 => u32::from_le_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ if num_geometries == 0 {
+ return Ok(None);
+ }
+
+ let mut i = 9;
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ i += 4;
+ }
+
+ // Recursive call to get the first geom of the first nested
geometry
+ // Add to current offset of i
+ let off = first_geom_idx(&buf[i..]);
+ if let Ok(Some(off)) = off {
+ Ok(Some(i + off))
+ } else {
+ Ok(None)
+ }
+ }
+ _ => sedona_internal_err!("Unexpected geometry type:
{geometry_type_id:?}"),
+ }
+}
+
+// Given a point, linestring, or polygon, return the first xy coordinate
+// If the geometry, is empty, (NaN, NaN) is returned
+fn first_xy(buf: &[u8]) -> Result<(f64, f64)> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> first_xy");
+ }
+
+ let byte_order = buf[0];
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order: {other}"),
+ };
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type & 0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ // 1 (byte_order) + 4 (geometry_type) = 5
+ let mut i = 5;
+
+ // Skip the SRID if it's present
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ i += 4;
+ }
+
+ if matches!(
+ geometry_type_id,
+ GeometryTypeId::LineString | GeometryTypeId::Polygon
+ ) {
+ if buf.len() < i + 4 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> first_xy3 {} is not < {}",
+ buf.len(),
+ i + 4
+ );
+ }
+ let size = match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i +
3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i +
3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ // (NaN, NaN) for empty geometries
+ if size == 0 {
+ return Ok((f64::NAN, f64::NAN));
+ }
+ // + 4 for size
+ i += 4;
+
+ // For POLYGON, after the number of rings, the next 4 bytes are the
+ // number of points in the exterior ring. We must skip that count to
+ // land on the first coordinate's x value.
+ if geometry_type_id == GeometryTypeId::Polygon {
+ if buf.len() < i + 4 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> polygon first ring size
{} is not < {}",
+ buf.len(),
+ i + 4
+ );
+ }
+ let ring0_num_points = match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ // (NaN, NaN) for empty first ring
+ if ring0_num_points == 0 {
+ return Ok((f64::NAN, f64::NAN));
+ }
+ i += 4;
+ }
+ }
+
+ if buf.len() < i + 8 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> first_xy4 {} is not < {}",
+ i + 8,
+ buf.len()
+ );
+ }
+ let x = parse_coord(&buf[i..], byte_order)?;
+ let y = parse_coord(&buf[i + 8..], byte_order)?;
+ Ok((x, y))
+}
+
+// Given a buffer starting at the coordinate itself, parse the x and y
coordinates
+fn parse_coord(buf: &[u8], byte_order: u8) -> Result<f64> {
+ if buf.len() < 8 {
+ return exec_err!("Invalid WKB: buffer too small -> parse_coord");
+ }
+
+ let coord: f64 = match byte_order {
+ 0 => f64::from_be_bytes([
+ buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], buf[7],
+ ]),
+ 1 => f64::from_le_bytes([
+ buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], buf[7],
+ ]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}")?,
+ };
+
+ Ok(coord)
+}
+
+// Parses the top-level dimension of the geometry
+fn parse_dimensions(buf: &[u8]) -> Result<Dimensions> {
+ if buf.len() < 9 {
+ return exec_err!("Invalid WKB: buffer too small -> parse_dimensions");
+ }
+
+ let byte_order = buf[0];
+
+ let code = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => sedona_internal_err!("Unexpected byte order: {other}")?,
+ };
+
+ match code / 1000 {
+ 0 => Ok(Dimensions::Xy),
+ 1 => Ok(Dimensions::Xyz),
+ 2 => Ok(Dimensions::Xym),
+ 3 => Ok(Dimensions::Xyzm),
+ _ => exec_err!("Unexpected code: {code:?}"),
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use std::str::FromStr;
+ use wkt::Wkt;
+
+ fn make_wkb(wkt_value: &'static str) -> Vec<u8> {
+ let geom = Wkt::<f64>::from_str(wkt_value).unwrap();
+ let mut buf: Vec<u8> = vec![];
+ wkb::writer::write_geometry(&mut buf, &geom,
Default::default()).unwrap();
+ buf
+ }
+
+ #[test]
+ fn geometry_type_id() {
+ let wkb = make_wkb("POINT (1 2)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("LINESTRING (1 2, 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::LineString
+ );
+
+ let wkb = make_wkb("POLYGON ((0 0, 0 1, 1 0, 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(),
GeometryTypeId::Polygon);
+
+ let wkb = make_wkb("MULTIPOINT ((1 2), (3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiPoint
+ );
+
+ let wkb = make_wkb("MULTILINESTRING ((1 2, 3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiLineString
+ );
+
+ let wkb = make_wkb("MULTIPOLYGON (((0 0, 0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiPolygon
+ );
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::GeometryCollection
+ );
+
+ // Some cases with z and m dimensions
+ let wkb = make_wkb("POINT Z (1 2 3)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("LINESTRING Z (1 2 3, 4 5 6)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::LineString
+ );
+
+ let wkb = make_wkb("POLYGON M ((0 0 0, 0 1 0, 1 0 0, 0 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(),
GeometryTypeId::Polygon);
+ }
+
+ #[test]
+ fn size() {
+ let wkb = make_wkb("LINESTRING (1 2, 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("POLYGON ((0 0, 0 1, 1 0, 0 0), (1 1, 1 2, 2 1, 1
1))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("MULTIPOINT ((1 2), (3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("MULTILINESTRING ((1 2, 3 4, 5 6), (7 8, 9 10, 11
12))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("MULTIPOLYGON (((0 0, 0 1, 1 0, 0 0)), ((1 1, 1 2,
2 1, 1 1)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 1);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2), LINESTRING (1 2,
3 4), POLYGON ((0 0, 0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 3);
+ }
+
+ #[test]
+ fn empty_size() {
+ let wkb = make_wkb("LINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("POLYGON EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("MULTIPOINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("MULTILINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("MULTIPOLYGON EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+ }
+
+ // #[test]
+ // fn srid() {
+ // // This doesn't work
+ // let wkb = make_wkb("SRID=4326;POINT (1 2)");
+ // println!("wkb: {:?}", wkb);
+ // let header = WkbHeader::try_new(&wkb).unwrap();
+ // assert_eq!(header.srid(), 4326);
+ // }
+
+ #[test]
+ fn first_xy() {
+ let wkb = make_wkb("POINT (-5 -2)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (-5.0, -2.0));
+
+ let wkb = make_wkb("LINESTRING (1 2, 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.0, 2.0));
+
+ let wkb = make_wkb("POLYGON ((0 0, 0 1, 1 0, 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (0.0, 0.0));
+
+ // Another polygon test since that logic is more complicated
+ let wkb = make_wkb("POLYGON ((1.5 0.5, 1.5 1.5, 1.5 0.5), (0 0, 0 1, 1
0, 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.5, 0.5));
+
+ let wkb = make_wkb("MULTIPOINT ((1 2), (3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.0, 2.0));
+
+ let wkb = make_wkb("MULTILINESTRING ((3 4, 1 2), (5 6, 7 8))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (3.0, 4.0));
+
+ let wkb = make_wkb("MULTIPOLYGON (((-1 -1, 0 1, 1 -1, -1 -1)), ((0 0,
0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (-1.0, -1.0));
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.0, 2.0));
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2), LINESTRING (1 2,
3 4), POLYGON ((0 0, 0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.0, 2.0));
+ }
+
+ #[test]
+ fn empty_first_xy() {
+ let wkb = make_wkb("POINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ let (x, y) = header.first_xy();
+ assert!(x.is_nan());
+ assert!(y.is_nan());
+
+ let wkb = make_wkb("LINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ let (x, y) = header.first_xy();
+ assert!(x.is_nan());
+ assert!(y.is_nan());
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ let (x, y) = header.first_xy();
+ assert!(x.is_nan());
+ assert!(y.is_nan());
+ }
+
+ #[test]
+ fn empty_geometry_type_id() {
+ let wkb = make_wkb("POINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("LINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::LineString
+ );
+
+ let wkb = make_wkb("POLYGON EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(),
GeometryTypeId::Polygon);
+
+ let wkb = make_wkb("MULTIPOINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiPoint
+ );
+
+ let wkb = make_wkb("MULTILINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiLineString
+ );
+
+ let wkb = make_wkb("MULTIPOLYGON EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiPolygon
+ );
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::GeometryCollection
+ );
+
+ // z, m cases
+ let wkb = make_wkb("POINT Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("POINT M EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("LINESTRING ZM EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::LineString
+ );
+ }
+
+ #[test]
+ fn dimensions() {
+ let wkb = make_wkb("POINT (1 2)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xy);
+
+ let wkb = make_wkb("POINT Z (1 2 3)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xyz);
+
+ let wkb = make_wkb("POINT M (1 2 3)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xym);
+
+ let wkb = make_wkb("POINT ZM (1 2 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xyzm);
+ }
+
+ #[test]
+ fn empty_geometry_dimensions() {
+ // POINTs
+ let wkb = make_wkb("POINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xy);
+
+ let wkb = make_wkb("POINT Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xyz);
+
+ let wkb = make_wkb("POINT M EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xym);
+
+ let wkb = make_wkb("POINT ZM EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xyzm);
+
+ // GEOMETRYCOLLECTIONs
+ let wkb = make_wkb("GEOMETRYCOLLECTION EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xy);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xyz);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION M EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xym);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION ZM EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xyzm);
+ }
+
+ #[test]
+ fn first_geom_dimensions() {
+ // Top-level dimension is xy, while nested geometry is xyz
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT Z (1 2 3))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions().unwrap(), Dimensions::Xyz);
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xy);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT ZM (1 2 3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions().unwrap(), Dimensions::Xyzm);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT M (1 2 3))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions().unwrap(), Dimensions::Xym);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT ZM (1 2 3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions().unwrap(), Dimensions::Xyzm);
+ }
+
+ #[test]
+ fn empty_geometry_first_geom_dimensions() {
+ let wkb = make_wkb("POINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions(), Some(Dimensions::Xy));
+
+ let wkb = make_wkb("LINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions(), Some(Dimensions::Xy));
+
+ let wkb = make_wkb("POLYGON Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions(), Some(Dimensions::Xyz));
+
+ // Empty collections should return None
+ let wkb = make_wkb("MULTIPOINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions(), None);
+
+ let wkb = make_wkb("MULTILINESTRING Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions(), None);
+
+ let wkb = make_wkb("MULTIPOLYGON M EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions(), None);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION ZM EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions(), None);
+ }
+}
Review Comment:
There also needs to be tests here for incomplete buffers. In theory you have
logic to check that if there are an insufficient number of bytes available on
the buffer you don't call `buf[i]`; however, if your checks are wrong the
process will crash.
This is another benefit of using something like the `WkbBuffer` I suggested
above (that logic is consolidated and you don't have to test as many cases).
##########
rust/sedona-geometry/src/wkb_header.rs:
##########
@@ -0,0 +1,728 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use crate::types::GeometryTypeId;
+use datafusion_common::{
+ error::{DataFusionError, Result},
+ exec_err,
+};
+use geo_traits::Dimensions;
+use sedona_common::sedona_internal_err;
+
+const SRID_FLAG_BIT: u32 = 0x20000000;
+
+/// Fast-path WKB header parser
+/// Performs operations lazily and caches them after the first computation
+pub struct WkbHeader {
+ geometry_type: u32,
+ // Not applicable for a point
+ // number of points for a linestring
+ // number of rings for a polygon
+ // number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ size: u32,
+ // SRID if given buffer was EWKB. Otherwise, 0.
+ srid: u32,
+ // First x,y coordinates for a point. Otherwise (f64::NAN, f64::NAN) if
empty
+ first_xy: (f64, f64),
+ // Dimensions of the first nested geometry of a collection or None if empty
+ // For POINT, LINESTRING, POLYGON, returns the dimensions of the geometry
+ first_geom_dimensions: Option<Dimensions>,
+}
+
+impl WkbHeader {
+ /// Creates a new [WkbHeader] from a buffer
+ pub fn try_new(buf: &[u8]) -> Result<Self> {
+ if buf.len() < 5 {
+ return sedona_internal_err!("Invalid WKB: buffer too small ->
try_new");
+ };
+
+ let byte_order = buf[0];
+
+ // Parse geometry type
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type &
0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ let mut i = 5;
+ let mut srid = 0;
+ // if EWKB
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ srid = match byte_order {
+ 0 => u32::from_be_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ 1 => u32::from_le_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+ i = 9;
+ }
+
+ let size = if geometry_type_id == GeometryTypeId::Point {
+ // Dummy value for a point
+ 1
+ } else {
+ match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ }
+ };
+
+ // Default values for empty geometries
+ let first_x;
+ let first_y;
+ let first_geom_dimensions: Option<Dimensions>;
+
+ let first_geom_idx = first_geom_idx(buf)?;
+ if let Some(i) = first_geom_idx {
+ first_geom_dimensions = Some(parse_dimensions(&buf[i..])?);
+ (first_x, first_y) = first_xy(&buf[i..])?;
+ } else {
+ first_geom_dimensions = None;
+ first_x = f64::NAN;
+ first_y = f64::NAN;
+ }
+
+ Ok(Self {
+ geometry_type,
+ srid,
+ size,
+ first_xy: (first_x, first_y),
+ first_geom_dimensions,
+ })
+ }
+
+ /// Returns the geometry type id of the WKB by only parsing the header
instead of the entire WKB
+ /// 1 -> Point
+ /// 2 -> LineString
+ /// 3 -> Polygon
+ /// 4 -> MultiPoint
+ /// 5 -> MultiLineString
+ /// 6 -> MultiPolygon
+ /// 7 -> GeometryCollection
+ ///
+ /// Spec: https://libgeos.org/specifications/wkb/
+ pub fn geometry_type_id(&self) -> Result<GeometryTypeId> {
+ // Only low 3 bits is for the base type, high bits include additional
info
+ let code = self.geometry_type & 0x7;
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(code)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ Ok(geometry_type_id)
+ }
+
+ /// Returns the size of the geometry
+ /// Not applicable for a point
+ /// Number of points for a linestring
+ /// Number of rings for a polygon
+ /// Number of geometries for a MULTIPOINT, MULTILINESTRING, MULTIPOLYGON,
or GEOMETRYCOLLECTION
+ pub fn size(&self) -> u32 {
+ self.size
+ }
+
+ /// Returns the SRID if given buffer was EWKB. Otherwise, 0.
+ pub fn srid(&self) -> u32 {
+ self.srid
+ }
+
+ /// Returns the first x, y coordinates for a point. Otherwise (f64::NAN,
f64::NAN) if empty
+ pub fn first_xy(&self) -> (f64, f64) {
+ self.first_xy
+ }
+
+ /// Returns the top-level dimension of the WKB
+ pub fn dimensions(&self) -> Result<Dimensions> {
+ let dimensions = match self.geometry_type / 1000 {
+ 0 => Dimensions::Xy,
+ 1 => Dimensions::Xyz,
+ 2 => Dimensions::Xym,
+ 3 => Dimensions::Xyzm,
+ _ => sedona_internal_err!("Unexpected code: {}",
self.geometry_type)?,
+ };
+ Ok(dimensions)
+ }
+
+ /// Returns the dimensions of the first coordinate of the geometry
+ pub fn first_geom_dimensions(&self) -> Option<Dimensions> {
+ self.first_geom_dimensions
+ }
+}
+
+// For MULITPOINT, MULTILINESTRING, MULTIPOLYGON, or GEOMETRYCOLLECTION,
returns the index to the first nested
+// non-collection geometry (POINT, LINESTRING, or POLYGON), or None if empty
+// For POINT, LINESTRING, POLYGON, returns 0 as it already is a non-collection
geometry
+fn first_geom_idx(buf: &[u8]) -> Result<Option<usize>> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> first_geom_idx");
+ }
+
+ let byte_order = buf[0];
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order: {other}"),
+ };
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type & 0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ match geometry_type_id {
+ GeometryTypeId::Point | GeometryTypeId::LineString |
GeometryTypeId::Polygon => Ok(Some(0)),
+ GeometryTypeId::MultiPoint
+ | GeometryTypeId::MultiLineString
+ | GeometryTypeId::MultiPolygon
+ | GeometryTypeId::GeometryCollection => {
+ if buf.len() < 9 {
+ exec_err!("Invalid WKB: buffer too small")?
+ }
+ let num_geometries = match byte_order {
+ 0 => u32::from_be_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ 1 => u32::from_le_bytes([buf[5], buf[6], buf[7], buf[8]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ if num_geometries == 0 {
+ return Ok(None);
+ }
+
+ let mut i = 9;
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ i += 4;
+ }
+
+ // Recursive call to get the first geom of the first nested
geometry
+ // Add to current offset of i
+ let off = first_geom_idx(&buf[i..]);
+ if let Ok(Some(off)) = off {
+ Ok(Some(i + off))
+ } else {
+ Ok(None)
+ }
+ }
+ _ => sedona_internal_err!("Unexpected geometry type:
{geometry_type_id:?}"),
+ }
+}
+
+// Given a point, linestring, or polygon, return the first xy coordinate
+// If the geometry, is empty, (NaN, NaN) is returned
+fn first_xy(buf: &[u8]) -> Result<(f64, f64)> {
+ if buf.len() < 5 {
+ return exec_err!("Invalid WKB: buffer too small -> first_xy");
+ }
+
+ let byte_order = buf[0];
+ let geometry_type = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => return sedona_internal_err!("Unexpected byte order: {other}"),
+ };
+
+ let geometry_type_id = GeometryTypeId::try_from_wkb_id(geometry_type & 0x7)
+ .map_err(|e| DataFusionError::External(Box::new(e)))?;
+
+ // 1 (byte_order) + 4 (geometry_type) = 5
+ let mut i = 5;
+
+ // Skip the SRID if it's present
+ if geometry_type & SRID_FLAG_BIT != 0 {
+ i += 4;
+ }
+
+ if matches!(
+ geometry_type_id,
+ GeometryTypeId::LineString | GeometryTypeId::Polygon
+ ) {
+ if buf.len() < i + 4 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> first_xy3 {} is not < {}",
+ buf.len(),
+ i + 4
+ );
+ }
+ let size = match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i +
3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i +
3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ // (NaN, NaN) for empty geometries
+ if size == 0 {
+ return Ok((f64::NAN, f64::NAN));
+ }
+ // + 4 for size
+ i += 4;
+
+ // For POLYGON, after the number of rings, the next 4 bytes are the
+ // number of points in the exterior ring. We must skip that count to
+ // land on the first coordinate's x value.
+ if geometry_type_id == GeometryTypeId::Polygon {
+ if buf.len() < i + 4 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> polygon first ring size
{} is not < {}",
+ buf.len(),
+ i + 4
+ );
+ }
+ let ring0_num_points = match byte_order {
+ 0 => u32::from_be_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ 1 => u32::from_le_bytes([buf[i], buf[i + 1], buf[i + 2], buf[i
+ 3]]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}"),
+ };
+
+ // (NaN, NaN) for empty first ring
+ if ring0_num_points == 0 {
+ return Ok((f64::NAN, f64::NAN));
+ }
+ i += 4;
+ }
+ }
+
+ if buf.len() < i + 8 {
+ return exec_err!(
+ "Invalid WKB: buffer too small -> first_xy4 {} is not < {}",
+ i + 8,
+ buf.len()
+ );
+ }
+ let x = parse_coord(&buf[i..], byte_order)?;
+ let y = parse_coord(&buf[i + 8..], byte_order)?;
+ Ok((x, y))
+}
+
+// Given a buffer starting at the coordinate itself, parse the x and y
coordinates
+fn parse_coord(buf: &[u8], byte_order: u8) -> Result<f64> {
+ if buf.len() < 8 {
+ return sedona_internal_err!("Invalid WKB: buffer too small ->
parse_coord");
+ }
+
+ let coord: f64 = match byte_order {
+ 0 => f64::from_be_bytes([
+ buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], buf[7],
+ ]),
+ 1 => f64::from_le_bytes([
+ buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6], buf[7],
+ ]),
+ other => return sedona_internal_err!("Unexpected byte order:
{other}")?,
+ };
+
+ Ok(coord)
+}
+
+// Parses the top-level dimension of the geometry
+fn parse_dimensions(buf: &[u8]) -> Result<Dimensions> {
+ if buf.len() < 9 {
+ return sedona_internal_err!("Invalid WKB: buffer too small ->
parse_dimensions");
+ }
+
+ let byte_order = buf[0];
+
+ let code = match byte_order {
+ 0 => u32::from_be_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ 1 => u32::from_le_bytes([buf[1], buf[2], buf[3], buf[4]]),
+ other => sedona_internal_err!("Unexpected byte order: {other}")?,
+ };
+
+ match code / 1000 {
+ 0 => Ok(Dimensions::Xy),
+ 1 => Ok(Dimensions::Xyz),
+ 2 => Ok(Dimensions::Xym),
+ 3 => Ok(Dimensions::Xyzm),
+ _ => sedona_internal_err!("Unexpected code: {code:?}"),
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use std::str::FromStr;
+ use wkt::Wkt;
+
+ fn make_wkb(wkt_value: &'static str) -> Vec<u8> {
+ let geom = Wkt::<f64>::from_str(wkt_value).unwrap();
+ let mut buf: Vec<u8> = vec![];
+ wkb::writer::write_geometry(&mut buf, &geom,
Default::default()).unwrap();
+ buf
+ }
+
+ #[test]
+ fn geometry_type_id() {
+ let wkb = make_wkb("POINT (1 2)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("LINESTRING (1 2, 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::LineString
+ );
+
+ let wkb = make_wkb("POLYGON ((0 0, 0 1, 1 0, 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(),
GeometryTypeId::Polygon);
+
+ let wkb = make_wkb("MULTIPOINT ((1 2), (3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiPoint
+ );
+
+ let wkb = make_wkb("MULTILINESTRING ((1 2, 3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiLineString
+ );
+
+ let wkb = make_wkb("MULTIPOLYGON (((0 0, 0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiPolygon
+ );
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::GeometryCollection
+ );
+
+ // Some cases with z and m dimensions
+ let wkb = make_wkb("POINT Z (1 2 3)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("LINESTRING Z (1 2 3, 4 5 6)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::LineString
+ );
+
+ let wkb = make_wkb("POLYGON M ((0 0 0, 0 1 0, 1 0 0, 0 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(),
GeometryTypeId::Polygon);
+ }
+
+ #[test]
+ fn size() {
+ let wkb = make_wkb("LINESTRING (1 2, 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("POLYGON ((0 0, 0 1, 1 0, 0 0), (1 1, 1 2, 2 1, 1
1))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("MULTIPOINT ((1 2), (3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("MULTILINESTRING ((1 2, 3 4, 5 6), (7 8, 9 10, 11
12))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("MULTIPOLYGON (((0 0, 0 1, 1 0, 0 0)), ((1 1, 1 2,
2 1, 1 1)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 2);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 1);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2), LINESTRING (1 2,
3 4), POLYGON ((0 0, 0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 3);
+ }
+
+ #[test]
+ fn empty_size() {
+ let wkb = make_wkb("LINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("POLYGON EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("MULTIPOINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("MULTILINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("MULTIPOLYGON EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.size(), 0);
+ }
+
+ // #[test]
+ // fn srid() {
+ // // This doesn't work
+ // let wkb = make_wkb("SRID=4326;POINT (1 2)");
+ // println!("wkb: {:?}", wkb);
+ // let header = WkbHeader::try_new(&wkb).unwrap();
+ // assert_eq!(header.srid(), 4326);
+ // }
+
+ #[test]
+ fn first_xy() {
+ let wkb = make_wkb("POINT (-5 -2)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (-5.0, -2.0));
+
+ let wkb = make_wkb("LINESTRING (1 2, 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.0, 2.0));
+
+ let wkb = make_wkb("POLYGON ((0 0, 0 1, 1 0, 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (0.0, 0.0));
+
+ // Another polygon test since that logic is more complicated
+ let wkb = make_wkb("POLYGON ((1.5 0.5, 1.5 1.5, 1.5 0.5), (0 0, 0 1, 1
0, 0 0))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.5, 0.5));
+
+ let wkb = make_wkb("MULTIPOINT ((1 2), (3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.0, 2.0));
+
+ let wkb = make_wkb("MULTILINESTRING ((3 4, 1 2), (5 6, 7 8))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (3.0, 4.0));
+
+ let wkb = make_wkb("MULTIPOLYGON (((-1 -1, 0 1, 1 -1, -1 -1)), ((0 0,
0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (-1.0, -1.0));
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.0, 2.0));
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT (1 2), LINESTRING (1 2,
3 4), POLYGON ((0 0, 0 1, 1 0, 0 0)))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_xy(), (1.0, 2.0));
+ }
+
+ #[test]
+ fn empty_first_xy() {
+ let wkb = make_wkb("POINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ let (x, y) = header.first_xy();
+ assert!(x.is_nan());
+ assert!(y.is_nan());
+
+ let wkb = make_wkb("LINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ let (x, y) = header.first_xy();
+ assert!(x.is_nan());
+ assert!(y.is_nan());
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ let (x, y) = header.first_xy();
+ assert!(x.is_nan());
+ assert!(y.is_nan());
+ }
+
+ #[test]
+ fn empty_geometry_type_id() {
+ let wkb = make_wkb("POINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("LINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::LineString
+ );
+
+ let wkb = make_wkb("POLYGON EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(),
GeometryTypeId::Polygon);
+
+ let wkb = make_wkb("MULTIPOINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiPoint
+ );
+
+ let wkb = make_wkb("MULTILINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiLineString
+ );
+
+ let wkb = make_wkb("MULTIPOLYGON EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::MultiPolygon
+ );
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::GeometryCollection
+ );
+
+ // z, m cases
+ let wkb = make_wkb("POINT Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("POINT M EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.geometry_type_id().unwrap(), GeometryTypeId::Point);
+
+ let wkb = make_wkb("LINESTRING ZM EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(
+ header.geometry_type_id().unwrap(),
+ GeometryTypeId::LineString
+ );
+ }
+
+ #[test]
+ fn dimensions() {
+ let wkb = make_wkb("POINT (1 2)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xy);
+
+ let wkb = make_wkb("POINT Z (1 2 3)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xyz);
+
+ let wkb = make_wkb("POINT M (1 2 3)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xym);
+
+ let wkb = make_wkb("POINT ZM (1 2 3 4)");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xyzm);
+ }
+
+ #[test]
+ fn empty_geometry_dimensions() {
+ // POINTs
+ let wkb = make_wkb("POINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xy);
+
+ let wkb = make_wkb("POINT Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xyz);
+
+ let wkb = make_wkb("POINT M EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xym);
+
+ let wkb = make_wkb("POINT ZM EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xyzm);
+
+ // GEOMETRYCOLLECTIONs
+ let wkb = make_wkb("GEOMETRYCOLLECTION EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xy);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xyz);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION M EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xym);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION ZM EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xyzm);
+ }
+
+ #[test]
+ fn first_geom_dimensions() {
+ // Top-level dimension is xy, while nested geometry is xyz
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT Z (1 2 3))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions().unwrap(), Dimensions::Xyz);
+ assert_eq!(header.dimensions().unwrap(), Dimensions::Xy);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT ZM (1 2 3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions().unwrap(), Dimensions::Xyzm);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT M (1 2 3))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions().unwrap(), Dimensions::Xym);
+
+ let wkb = make_wkb("GEOMETRYCOLLECTION (POINT ZM (1 2 3 4))");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions().unwrap(), Dimensions::Xyzm);
+ }
+
+ #[test]
+ fn empty_geometry_first_geom_dimensions() {
+ let wkb = make_wkb("POINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions(), Some(Dimensions::Xy));
+
+ let wkb = make_wkb("LINESTRING EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions(), Some(Dimensions::Xy));
+
+ let wkb = make_wkb("POLYGON Z EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions(), Some(Dimensions::Xyz));
+
+ // Empty collections should return None
+ let wkb = make_wkb("MULTIPOINT EMPTY");
+ let header = WkbHeader::try_new(&wkb).unwrap();
+ assert_eq!(header.first_geom_dimensions(), None);
Review Comment:
I think None is reasonable here (i.e., there are no sequences)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
