Struct elastic_types::geo::point::GeoPoint

pub struct GeoPoint<TMapping> where
    TMapping: GeoPointMapping,  { /* fields omitted */ }

An Elasticsearch geo_point type with a format.

The format is provided as a generic parameter. This struct wraps up a geo::Point struct, which have an x and y floating point value.

Examples

Defining a geo point using the default format:

let point: GeoPoint<DefaultGeoPointMapping> = GeoPoint::build(1.0, 1.0);

Defining a geo point using a named format:

let point: GeoPoint<DefaultGeoPointMapping<GeoPointString>> = GeoPoint::build(1.0, 1.0);

Accessing the values of a geo point:

let point: GeoPoint<DefaultGeoPointMapping> = GeoPoint::build(1.0, 1.0);

//eg: (1.0,1.0)
println!("({},{})",
    point.x(),
    point.y()
);

Links

• Elasticsearch Doc

Methods

impl<TMapping> GeoPoint<TMapping> where
    TMapping: GeoPointMapping, 

pub fn new<I>(point: I) -> Self where
    I: Into<P<f64>>, 

Creates a new GeoPoint from the given coordinate.

This function will consume the provided Coordinate.

Examples

use geo::{ Point, Coordinate };
use elastic_types::prelude::*;

//Create a geo Coordinate struct
let coord = Coordinate { x: 1.0, y: 1.0 };

//Give it to the GeoPoint struct
let point: GeoPoint<DefaultGeoPointMapping> = GeoPoint::new(Point(coord));

pub fn build(x: f64, y: f64) -> Self

Creates an GeoPoint from the given x and y primitives:

let point: GeoPoint<DefaultGeoPointMapping> = GeoPoint::build(1.0, 1.0);

pub fn remap<TNewMapping>(point: GeoPoint<TMapping>) -> GeoPoint<TNewMapping> where
    TNewMapping: GeoPointMapping, 

Change the format/mapping of this geo point.

Examples

//Get a point formatted as a string
let point: GeoPoint<DefaultGeoPointMapping<GeoPointString>> = GeoPoint::build(1.0, 1.0);

//Change the format to an object
let otherpoint: GeoPoint<DefaultGeoPointMapping<GeoPointObject>> = GeoPoint::remap(point);

Methods from Deref<Target = P<f64>>

pub fn x(&self) -> T

Returns the x/horizontal component of the point.

use geo::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.x(), 1.234);

pub fn y(&self) -> T

Returns the y/vertical component of the point.

use geo::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.y(), 2.345);

pub fn lng(&self) -> T

Returns the longitude/horizontal component of the point.

use geo::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.lng(), 1.234);

pub fn lat(&self) -> T

Returns the latitude/vertical component of the point.

use geo::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.lat(), 2.345);

pub fn dot(&self, point: &Point<T>) -> T

Returns the dot product of the two points: dot = x1 * x2 + y1 * y2

use geo::Point;

let p = Point::new(1.5, 0.5);
let dot = p.dot(&Point::new(2.0, 4.5));

assert_eq!(dot, 5.25);

Trait Implementations

impl<TMapping> GeoPointFieldType<TMapping> for GeoPoint<TMapping> where
    TMapping: GeoPointMapping, 

impl<TMapping: PartialEq> PartialEq<GeoPoint<TMapping>> for GeoPoint<TMapping> where
    TMapping: GeoPointMapping, 

fn eq(&self, other: &GeoPoint<TMapping>) -> bool

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

fn ne(&self, other: &GeoPoint<TMapping>) -> bool

This method tests for !=.

impl<M> PartialEq<Point<f64>> for GeoPoint<M> where
    M: GeoPointMapping, 

fn eq(&self, other: &P<f64>) -> bool

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

fn ne(&self, other: &P<f64>) -> bool

This method tests for !=.

impl<M> PartialEq<GeoPoint<M>> for P<f64> where
    M: GeoPointMapping, 

fn eq(&self, other: &GeoPoint<M>) -> bool

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

fn ne(&self, other: &GeoPoint<M>) -> bool

This method tests for !=.

impl<M> From<Point<f64>> for GeoPoint<M> where
    M: GeoPointMapping, 

fn from(value: P<f64>) -> Self

Performs the conversion.

impl<TMapping> From<Coordinate<f64>> for GeoPoint<TMapping> where
    TMapping: GeoPointMapping, 

fn from(point: C<f64>) -> GeoPoint<TMapping>

Performs the conversion.

impl<TMapping: Clone> Clone for GeoPoint<TMapping> where
    TMapping: GeoPointMapping, 

fn clone(&self) -> GeoPoint<TMapping>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M> Deref for GeoPoint<M> where
    M: GeoPointMapping, 

type Target = P<f64>

The resulting type after dereferencing.

fn deref(&self) -> &P<f64>

Dereferences the value.

impl<TMapping: Debug> Debug for GeoPoint<TMapping> where
    TMapping: GeoPointMapping, 

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

Formats the value using the given formatter.

impl<M> Borrow<Point<f64>> for GeoPoint<M> where
    M: GeoPointMapping, 

fn borrow(&self) -> &P<f64>

Immutably borrows from an owned value.

impl<TMapping> ToGeo<f64> for GeoPoint<TMapping> where
    TMapping: GeoPointMapping, 

fn to_geo(&self) -> G<f64>

impl<TMapping> Serialize for GeoPoint<TMapping> where
    TMapping: GeoPointMapping, 

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

Serialize this value into the given Serde serializer.

impl<'de, TMapping> Deserialize<'de> for GeoPoint<TMapping> where
    TMapping: GeoPointMapping, 

fn deserialize<D>(deserializer: D) -> Result<GeoPoint<TMapping>, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.