Struct geocoding::openstreetmap::Openstreetmap

pub struct Openstreetmap { /* private fields */ }

An instance of the Openstreetmap geocoding service

Implementations

impl Openstreetmap

pub fn new() -> Self

Create a new Openstreetmap geocoding instance using the default endpoint

pub fn new_with_endpoint(endpoint: String) -> Self

Create a new Openstreetmap geocoding instance with a custom endpoint.

Endpoint should include a trailing slash (i.e. “https://nominatim.openstreetmap.org/”)

pub fn forward_full<T>(
    &self,
    params: &OpenstreetmapParams<'_, T>
) -> Result<OpenstreetmapResponse<T>, GeocodingError> where
    T: Float + Debug,
    for<'de> T: Deserialize<'de>, 

A forward-geocoding lookup of an address, returning a full detailed response

Accepts an OpenstreetmapParams struct for specifying options, including whether to include address details in the response and whether to filter by a bounding box.

Please see the documentation for details.

This method passes the format parameter to the API.

Examples

use geocoding::{Openstreetmap, InputBounds, Point};
use geocoding::openstreetmap::{OpenstreetmapParams, OpenstreetmapResponse};

let osm = Openstreetmap::new();
let viewbox = InputBounds::new(
    (-0.13806939125061035, 51.51989264641164),
    (-0.13427138328552246, 51.52319711775629),
);
let params = OpenstreetmapParams::new(&"UCL CASA")
    .with_addressdetails(true)
    .with_viewbox(&viewbox)
    .build();
let res: OpenstreetmapResponse<f64> = osm.forward_full(&params).unwrap();
let result = res.features[0].properties.clone();
assert!(result.display_name.contains("Gordon Square"));

Trait Implementations

impl Default for Openstreetmap

fn default() -> Self

Returns the “default value” for a type.

impl<T> Forward<T> for Openstreetmap where
    T: Float + Debug,
    for<'de> T: Deserialize<'de>, 

fn forward(&self, place: &str) -> Result<Vec<Point<T>>, GeocodingError>

A forward-geocoding lookup of an address. Please see the documentation for details.

This method passes the format parameter to the API.

impl<T> Reverse<T> for Openstreetmap where
    T: Float + Debug,
    for<'de> T: Deserialize<'de>, 

fn reverse(&self, point: &Point<T>) -> Result<Option<String>, GeocodingError>

A reverse lookup of a point. More detail on the format of the returned String can be found here

This method passes the format parameter to the API.