Enum elasticsearch_dsl::search::params::GeoShape

pub enum GeoShape {
    Point {
        coordinates: GeoLocation,
    },
    LineString {
        coordinates: Vec<GeoLocation>,
    },
    Polygon {
        coordinates: Vec<Vec<GeoLocation>>,
    },
    MultiPoint {
        coordinates: Vec<GeoLocation>,
    },
    MultiLineString {
        coordinates: Vec<Vec<GeoLocation>>,
    },
    MultiPolygon {
        coordinates: Vec<Vec<Vec<GeoLocation>>>,
    },
    Envelope {
        coordinates: (GeoLocation, GeoLocation),
    },
    Circle {
        coordinates: GeoLocation,
        radius: Distance,
    },
    GeometryCollection {
        geometries: Vec<GeoShape>,
    },
}

The geo_shape data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles and polygons. It should be used when either the data being indexed or the queries being executed contain shapes other than just points.

Variants

Point

Fields

coordinates: GeoLocation

Coordinates

A single geographic coordinate

Note: Elasticsearch uses WGS-84 coordinates only

LineString

Fields

coordinates: Vec<GeoLocation>

Coordinates

An arbitrary line given two or more points

Polygon

Fields

coordinates: Vec<Vec<GeoLocation>>

Coordinates

A closed polygon whose first and last point must match, thus requiring n + 1 vertices to create an n-sided polygon and a minimum of 4 vertices

MultiPoint

Fields

coordinates: Vec<GeoLocation>

Coordinates

An array of unconnected, but likely related points

MultiLineString

Fields

coordinates: Vec<Vec<GeoLocation>>

Coordinates

An array of separate linestrings

MultiPolygon

Fields

coordinates: Vec<Vec<Vec<GeoLocation>>>

Coordinates

An array of separate polygons

Envelope

Fields

coordinates: (GeoLocation, GeoLocation)

Coordinates

A bounding rectangle, or envelope, specified by specifying only the top left and bottom right points.

Circle

Fields

coordinates: GeoLocation

Coordinates

radius: Distance

Circle radius

A circle specified by a center point and radius with units, which default to METERS

GeometryCollection

Fields

geometries: Vec<GeoShape>

A collection of geo shapes

A GeoJSON shape similar to the multi* shapes except that multiple types can coexist (e.g., a Point and a LineString)

Implementations

impl GeoShape

pub fn point<T>(coordinates: T) -> Self where
    T: Into<GeoLocation>, 

Creates an instance of GeoShape::Point

pub fn line_string<T>(coordinates: T) -> Self where
    T: IntoIterator,
    T::Item: Into<GeoLocation>, 

Creates an instance of GeoShape::LineString

pub fn polygon<T>(coordinates: T) -> Self where
    T: IntoIterator,
    T::Item: IntoIterator,
    <T::Item as IntoIterator>::Item: Into<GeoLocation>, 

Creates an instance of GeoShape::Polygon

pub fn multi_point<T>(coordinates: T) -> Self where
    T: IntoIterator,
    T::Item: Into<GeoLocation>, 

Creates an instance of GeoShape::MultiPoint

pub fn multi_line_string<T>(coordinates: T) -> Self where
    T: IntoIterator,
    T::Item: IntoIterator,
    <T::Item as IntoIterator>::Item: Into<GeoLocation>, 

Creates an instance of GeoShape::MultiLineString

pub fn multi_polygon<T>(coordinates: T) -> Self where
    T: IntoIterator,
    T::Item: IntoIterator,
    <T::Item as IntoIterator>::Item: IntoIterator,
    <<T::Item as IntoIterator>::Item as IntoIterator>::Item: Into<GeoLocation>, 

Creates an instance of GeoShape::MultiPolygon

pub fn envelope<T>(top_left: T, bottom_right: T) -> Self where
    T: Into<GeoLocation>, 

Creates an instance of GeoShape::Envelope

pub fn circle<T, R>(coordinates: T, radius: R) -> Self where
    T: Into<GeoLocation>,
    R: Into<Distance>, 

Creates an instance of GeoShape::Circle

pub fn geometry_collection<T>(geometries: T) -> Self where
    T: IntoIterator,
    T::Item: Into<Self>, 

Creates an instance of GeoShape::GeometryCollection

Trait Implementations

impl Clone for GeoShape

fn clone(&self) -> GeoShape

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GeoShape

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

Formats the value using the given formatter.

impl PartialEq<GeoShape> for GeoShape

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for GeoShape

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GeoShape