Struct nominatim_rs::search::SearchQueryBuilder

pub struct SearchQueryBuilder { /* private fields */ }

Builder for SearchQuery.

Implementations

impl SearchQueryBuilder

pub fn location_query(&mut self, value: LocationQuery) -> &mut Self

pub fn address_details(&mut self, value: bool) -> &mut Self

Include a breakdown of the address into elements

pub fn extra_tags(&mut self, value: bool) -> &mut Self

Include additional information if the result is available

pub fn name_details(&mut self, value: bool) -> &mut Self

Include a list of alternative names in the results. This may include language variants, references, operator and brand.

pub fn accept_language(&mut self, value: Option<Vec<String>>) -> &mut Self

Preferred language order for showing search results, overrides the value specified in the “Accept-Languague” HTTP header. Either use a standard RFC2616 accept-language string or a simple comma-separated list of language codes.

pub fn country_codes(&mut self, value: Option<Vec<String>>) -> &mut Self

Include addition information if the result is available Limit search results to one of more countries. The country code must be the ISO-3166-1alpha2 code, e.g. gb for the United Kingdom, de for Germany.

Each place in Nominatim is assigned to one country code based of OSM country borders. In rare cases a place may not be in any country at all, for example, in international waters.

pub fn exclude_place_ids(&mut self, value: Option<Vec<u64>>) -> &mut Self

If you do not want certain OSM objects to appear in the search result, give a comma separated list of the place_ids you want to skip. This can be used to retrieve additional search results. For example, if a previous query only returned a few results, then including those here would cause the search to return other, less accurate, matches (if possible.)

pub fn limit(&mut self, value: Option<u8>) -> &mut Self

Limits the number of returned results. (Default: 10, Maximum: 50.)

pub fn viewbox(&mut self, value: Option<[f64; 4]>) -> &mut Self

The preferred area to find search results. Any two corner points of the box are accepted as long as they span a real box.

viewbox=<x1>,<y1>,<x2>,<y2>

pub fn dedupe(&mut self, value: bool) -> &mut Self

Sometimes you have several objects in OSM identifying the same place or object in reality. The simplest case is a street being split into many different OSM ways due to different characteristics. Nominatim will attempt to detect such duplicates and only return on match unless this parameter is set to false. (Default: true),

pub fn build(&self) -> Result<SearchQuery, SearchQueryBuilderError>

Builds a new SearchQuery.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for SearchQueryBuilder

fn clone(&self) -> SearchQueryBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SearchQueryBuilder

fn default() -> Self

Returns the “default value” for a type.