Struct elastic_types::geo::shape::mapping::DefaultGeoShapeMapping

pub struct DefaultGeoShapeMapping;

Default mapping for geo_shape.

Trait Implementations

impl GeoShapeMapping for DefaultGeoShapeMapping

fn tree() -> Option<Tree>

Name of the PrefixTree implementation to be used: geohash for GeohashPrefixTree and quadtree for QuadPrefixTree.

fn precision() -> Option<Distance>

This parameter may be used instead of tree_levels to set an appropriate value for the tree_levels parameter. The value specifies the desired precision and Elasticsearch will calculate the best tree_levels value to honor this precision. The value should be a number followed by an optional distance unit.

fn tree_levels() -> Option<i32>

Maximum number of layers to be used by the PrefixTree. This can be used to control the precision of shape representations and therefore how many terms are indexed. Defaults to the default value of the chosen PrefixTree implementation. Since this parameter requires a certain level of understanding of the underlying implementation, users may use the precision parameter instead. However, Elasticsearch only uses the tree_levels parameter internally and this is what is returned via the mapping API even if you use the precision parameter.

fn strategy() -> Option<Strategy>

The strategy parameter defines the approach for how to represent shapes at indexing and search time. It also influences the capabilities available so it is recommended to let Elasticsearch set this parameter automatically. There are two strategies available: recursive and term. Term strategy supports point types only (the points_only parameter will be automatically set to true) while Recursive strategy supports all shape types.

fn distance_error_pct() -> Option<f32>

Used as a hint to the PrefixTree about how precise it should be. Defaults to 0.025 (2.5%) with 0.5 as the maximum supported value.

fn orientation() -> Option<Orientation>

Setting this parameter in the geo_shape mapping explicitly sets vertex order for the coordinate list of a geo_shape field but can be overridden in each individual GeoJSON document.

fn points_only() -> Option<bool>

Setting this option to true (defaults to false) configures the geo_shape field type for point shapes only (NOTE: Multi-Points are not yet supported). This optimizes index and search performance for the geohash and quadtree when it is known that only points will be indexed. At present geo_shape queries can not be executed on geo_point field types. This option bridges the gap by improving point performance on a geo_shape field so that geo_shape queries are optimal on a point only field.

impl Clone for DefaultGeoShapeMapping

fn clone(&self) -> DefaultGeoShapeMapping

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<DefaultGeoShapeMapping> for DefaultGeoShapeMapping

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

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

#[must_use]

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

This method tests for !=.

impl Copy for DefaultGeoShapeMapping

impl Default for DefaultGeoShapeMapping

fn default() -> DefaultGeoShapeMapping

Returns the "default value" for a type.

impl Debug for DefaultGeoShapeMapping

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

Formats the value using the given formatter.