Struct photon_geocoding::filter::ForwardFilter

pub struct ForwardFilter {
    pub location_bias: Option<LatLon>,
    pub location_bias_zoom: Option<u64>,
    pub location_bias_scale: Option<f64>,
    pub bounding_box: Option<BoundingBox>,
    pub limit: Option<u64>,
    pub lang: Option<String>,
    pub layer: Option<Vec<PhotonLayer>>,
    pub additional_query: Option<Vec<(String, String)>>,
}

Filtering options for forward searches. This struct implements a builder pattern, so filters can be easily constructed.

Fields

location_bias: Option<LatLon>

location_bias_zoom: Option<u64>

location_bias_scale: Option<f64>

bounding_box: Option<BoundingBox>

limit: Option<u64>

lang: Option<String>

layer: Option<Vec<PhotonLayer>>

additional_query: Option<Vec<(String, String)>>

Implementations

impl ForwardFilter

pub fn new() -> Self

Construct a new ForwardFilter. All fields are set to None in the beginning.

pub fn location_bias(
    self,
    coords: LatLon,
    zoom: Option<u64>,
    scale: Option<f64>
) -> Self

Concentrate the search around a specific coordinate.

zoom describes the radius around the coordinate to focus on. scale describes how much the prominence of a result should still be taken into account. See Photon documentation for details

pub fn bounding_box(self, bbox: BoundingBox) -> Self

Concentrate the search in a specific rectangular area.

pub fn limit(self, limit: u64) -> Self

Limit the number of search results.

pub fn language(self, lang: &str) -> Self

Return results in a specific language. Photon currently supports DE, EN and FR. Defaults to the local language of a search result.

pub fn layer(self, layer: Vec<PhotonLayer>) -> Self

Filter results by layer. See Photon documentation

pub fn additional_query(self, query: Vec<(&str, &str)>) -> Self

Add additional query strings to the request. Example: Filtering by tags and values

Trait Implementations

impl Default for ForwardFilter

fn default() -> Self

Returns the “default value” for a type.