Struct Wkb

pub struct Wkb<'a>(/* private fields */);

Parse a WKB byte slice into a geometry.

An opaque object that implements GeometryTrait. Use methods provided by geo_traits to access the underlying data.

The contained dimension will never be Unknown.

Implementations

impl<'a> Wkb<'a>

pub fn try_new(buf: &'a [u8]) -> WkbResult<Self>

Parse a WKB byte slice into a geometry.

Performance

WKB is not a zero-copy format because coordinates are not 8-byte aligned and because an initial scan needs to take place to know internal buffer offsets.

This function does an initial pass over the WKB buffer to validate the contents and record the byte offsets for relevant coordinate slices but does not copy the underlying data to an alternate representation. This means that coordinates will always be constant-time to access but not zero-copy. This is because the raw WKB buffer is not 8-byte aligned, so when accessing a coordinate the underlying bytes need to be copied into a newly-allocated f64.

pub fn dimension(&self) -> Dimension

pub fn geometry_type(&self) -> GeometryType

Return the GeometryType of this geometry.

Trait Implementations

impl<'a> Clone for Wkb<'a>

fn clone(&self) -> Wkb<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Wkb<'a>

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

Formats the value using the given formatter.

impl<'a> GeometryTrait for &Wkb<'a>

type T = f64

The coordinate type of this geometry

type PointType<'b> = Point<'a> where Self: 'b

The type of each underlying Point, which implements PointTrait

type LineStringType<'b> = LineString<'a> where Self: 'b

The type of each underlying LineString, which implements LineStringTrait

type PolygonType<'b> = Polygon<'a> where Self: 'b

The type of each underlying Polygon, which implements PolygonTrait

type MultiPointType<'b> = MultiPoint<'a> where Self: 'b

The type of each underlying MultiPoint, which implements MultiPointTrait

type MultiLineStringType<'b> = MultiLineString<'a> where Self: 'b

The type of each underlying MultiLineString, which implements MultiLineStringTrait

type MultiPolygonType<'b> = MultiPolygon<'a> where Self: 'b

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

type GeometryCollectionType<'b> = GeometryCollection<'a> where Self: 'b

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

type RectType<'b> = UnimplementedRect<f64> where Self: 'b

The type of each underlying Rect, which implements RectTrait

type TriangleType<'b> = UnimplementedTriangle<f64> where Self: 'b

The type of each underlying Triangle, which implements TriangleTrait

type LineType<'b> = UnimplementedLine<f64> where Self: 'b

The type of each underlying Line, which implements LineTrait

fn dim(&self) -> Dimensions

The dimension of this geometry

fn as_type( &self, ) -> GeometryType<'_, Self::PointType<'_>, Self::LineStringType<'_>, Self::PolygonType<'_>, Self::MultiPointType<'_>, Self::MultiLineStringType<'_>, Self::MultiPolygonType<'_>, Self::GeometryCollectionType<'_>, Self::RectType<'_>, Self::TriangleType<'_>, Self::LineType<'_>>

Cast this geometry to a GeometryType enum, which allows for downcasting to a specific type

impl<'a> GeometryTrait for Wkb<'a>

type T = f64

The coordinate type of this geometry

type PointType<'b> = Point<'a> where Self: 'b

The type of each underlying Point, which implements PointTrait

type LineStringType<'b> = LineString<'a> where Self: 'b

The type of each underlying LineString, which implements LineStringTrait

type PolygonType<'b> = Polygon<'a> where Self: 'b

The type of each underlying Polygon, which implements PolygonTrait

type MultiPointType<'b> = MultiPoint<'a> where Self: 'b

The type of each underlying MultiPoint, which implements MultiPointTrait

type MultiLineStringType<'b> = MultiLineString<'a> where Self: 'b

The type of each underlying MultiLineString, which implements MultiLineStringTrait

type MultiPolygonType<'b> = MultiPolygon<'a> where Self: 'b

The type of each underlying MultiPolygon, which implements MultiPolygonTrait

type GeometryCollectionType<'b> = GeometryCollection<'a> where Self: 'b

The type of each underlying GeometryCollection, which implements GeometryCollectionTrait

type RectType<'b> = UnimplementedRect<f64> where Self: 'b

The type of each underlying Rect, which implements RectTrait

type TriangleType<'b> = UnimplementedTriangle<f64> where Self: 'b

The type of each underlying Triangle, which implements TriangleTrait

type LineType<'b> = UnimplementedLine<f64> where Self: 'b

The type of each underlying Line, which implements LineTrait

fn dim(&self) -> Dimensions

The dimension of this geometry

fn as_type( &self, ) -> GeometryType<'_, Self::PointType<'_>, Self::LineStringType<'_>, Self::PolygonType<'_>, Self::MultiPointType<'_>, Self::MultiLineStringType<'_>, Self::MultiPolygonType<'_>, Self::GeometryCollectionType<'_>, Self::RectType<'_>, Self::TriangleType<'_>, Self::LineType<'_>>

Cast this geometry to a GeometryType enum, which allows for downcasting to a specific type