Enum Geometry 

pub enum Geometry {
    Point(Point<f64>),
    Line(LineString<f64>),
    Polygon(Polygon<f64>),
    MultiPoint(MultiPoint<f64>),
    MultiLine(MultiLineString<f64>),
    MultiPolygon(MultiPolygon<f64>),
    Collection(Vec<Geometry>),
}

Represents geometric shapes in SurrealDB

Geometry types support various geometric shapes including points, lines, polygons, and their multi-variants. This is useful for spatial data and geographic applications.

The types used internally originate from the geo crate.

Variants

Point(Point<f64>)

A single point in 2D space

Line(LineString<f64>)

A line consisting of multiple connected points

Polygon(Polygon<f64>)

A polygon with an exterior boundary and optional interior holes

MultiPoint(MultiPoint<f64>)

Multiple points

MultiLine(MultiLineString<f64>)

Multiple lines

MultiPolygon(MultiPolygon<f64>)

Multiple polygons

Collection(Vec<Geometry>)

A collection of different geometry types

Implementations

impl Geometry

pub fn kind(&self) -> GeometryKind

Get the kind of geometry

pub fn is_point(&self) -> bool

Check if this is a of the given type

pub fn into_point(self) -> Result<Point<f64>>

Convert this geometry into the given type

pub fn from_point(v: Point<f64>) -> Self

Create a new geometry from the given type

pub fn is_line(&self) -> bool

Check if this is a of the given type

pub fn into_line(self) -> Result<LineString<f64>>

Convert this geometry into the given type

pub fn from_line(v: LineString<f64>) -> Self

Create a new geometry from the given type

pub fn is_polygon(&self) -> bool

Check if this is a of the given type

pub fn into_polygon(self) -> Result<Polygon<f64>>

Convert this geometry into the given type

pub fn from_polygon(v: Polygon<f64>) -> Self

Create a new geometry from the given type

pub fn is_multipoint(&self) -> bool

Check if this is a of the given type

pub fn into_multipoint(self) -> Result<MultiPoint<f64>>

Convert this geometry into the given type

pub fn from_multipoint(v: MultiPoint<f64>) -> Self

Create a new geometry from the given type

pub fn is_multiline(&self) -> bool

Check if this is a of the given type

pub fn into_multiline(self) -> Result<MultiLineString<f64>>

Convert this geometry into the given type

pub fn from_multiline(v: MultiLineString<f64>) -> Self

Create a new geometry from the given type

pub fn is_multipolygon(&self) -> bool

Check if this is a of the given type

pub fn into_multipolygon(self) -> Result<MultiPolygon<f64>>

Convert this geometry into the given type

pub fn from_multipolygon(v: MultiPolygon<f64>) -> Self

Create a new geometry from the given type

pub fn is_collection(&self) -> bool

Check if this is a of the given type

pub fn into_collection(self) -> Result<Vec<Geometry>>

Convert this geometry into the given type

pub fn from_collection(v: Vec<Geometry>) -> Self

Create a new geometry from the given type

impl Geometry

pub fn is_valid(&self) -> bool

Check if this has valid latitude and longitude points:

• -90 <= lat <= 90
• -180 <= lng <= 180

pub fn as_type(&self) -> &'static str

Get the type of this Geometry as text

pub fn as_coordinates(&self) -> Value

Get the raw coordinates of this Geometry as an Array

pub fn as_object(&self) -> Object

Convert this geometry into an object

pub fn try_from_object(object: &Object) -> Option<Geometry>

Try to convert an object into a geometry

Trait Implementations

impl Clone for Geometry

fn clone(&self) -> Geometry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Geometry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Geometry

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Geometry

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

Formats the value using the given formatter.

impl FromFlatbuffers for Geometry

type Input<'a> = Geometry<'a>

The input type from the flatbuffers builder

fn from_fb(input: Self::Input<'_>) -> Result<Self>

Convert a flatbuffers builder type to a type.

impl Hash for Geometry

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Geometry

fn eq(&self, other: &Geometry) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Geometry

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Geometry

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SurrealValue for Geometry

fn kind_of() -> Kind

Returns the kind that represents this type

fn is_value(value: &Value) -> bool

Checks if the given value can be converted to this type

fn into_value(self) -> Value

Converts this type into a SurrealDB value

fn from_value(value: Value) -> Result<Self, Error>

Attempts to convert a SurrealDB value into this type

impl ToFlatbuffers for Geometry

type Output<'bldr> = WIPOffset<Geometry<'bldr>>

The output type for the flatbuffers builder

fn to_fb<'bldr>( &self, builder: &mut FlatBufferBuilder<'bldr>, ) -> Result<Self::Output<'bldr>>

Convert the type to a flatbuffers builder type.

impl ToSql for Geometry

fn fmt_sql(&self, f: &mut String, _fmt: SqlFormat)

Format the type to a SQL string.

fn to_sql(&self) -> String

Convert the type to a SQL string.

fn to_sql_pretty(&self) -> String

Convert the type to a pretty-printed SQL string with indentation.

impl StructuralPartialEq for Geometry