Enum elasticsearch_dsl::search::params::Shape

pub enum Shape {
    Point {
        coordinates: Coordinate,
    },
    LineString {
        coordinates: Vec<Coordinate>,
    },
    Polygon {
        coordinates: Vec<Vec<Coordinate>>,
    },
    MultiPoint {
        coordinates: Vec<Coordinate>,
    },
    MultiLineString {
        coordinates: Vec<Vec<Coordinate>>,
    },
    MultiPolygon {
        coordinates: Vec<Vec<Vec<Coordinate>>>,
    },
    Envelope {
        coordinates: (Coordinate, Coordinate),
    },
    GeometryCollection {
        geometries: Vec<Shape>,
    },
}

The shape data type facilitates the indexing of and searching with arbitrary x, y cartesian shapes such as rectangles and polygons. It can be used to index and query geometries whose coordinates fall in a 2-dimensional planar coordinate system.

Variants

Point

Fields

coordinates: Coordinate

Coordinates

A single x, y coordinate

LineString

Fields

coordinates: Vec<Coordinate>

Coordinates

An arbitrary line given two or more points

Polygon

Fields

coordinates: Vec<Vec<Coordinate>>

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<Coordinate>

Coordinates

An array of unconnected, but likely related points

MultiLineString

Fields

coordinates: Vec<Vec<Coordinate>>

Coordinates

An array of separate linestrings

MultiPolygon

Fields

coordinates: Vec<Vec<Vec<Coordinate>>>

Coordinates

An array of separate polygons

Envelope

Fields

coordinates: (Coordinate, Coordinate)

Coordinates

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

GeometryCollection

Fields

geometries: Vec<Shape>

A collection of shapes

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

Implementations

impl Shape

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

Creates an instance of Shape::Point

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

Creates an instance of Shape::LineString

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

Creates an instance of Shape::Polygon

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

Creates an instance of Shape::MultiPoint

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

Creates an instance of Shape::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<Coordinate>, 

Creates an instance of Shape::MultiPolygon

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

Creates an instance of Shape::Envelope

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

Creates an instance of Shape::GeometryCollection

Trait Implementations

impl Clone for Shape

fn clone(&self) -> Shape

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Shape

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

Formats the value using the given formatter.

impl PartialEq<Shape> for Shape

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

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

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

This method tests for !=.

impl Serialize for Shape

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 Shape