Struct PhotonApiClient

pub struct PhotonApiClient { /* private fields */ }

Implementations

impl Client

pub fn new(base_url: &str) -> Self

Creates a new API client with the specified base_url.

base_url must begin with http:// or https://.

pub fn forward_search( &self, query: &str, filter: Option<ForwardFilter>, ) -> Result<Vec<PhotonFeature>, Box<dyn Error>>

Performs a forward search for the provided query.

Results can be filtered by the optional filter. Pass None for no filter.

This function is blocking, so no async features are involved here. It is, however, safe to call this function in parallel, since the entire API client is thread-safe.

pub fn reverse_search( &self, coords: LatLon, filter: Option<ReverseFilter>, ) -> Result<Vec<PhotonFeature>, Box<dyn Error>>

Performs a reverse search for objects at the specified coords.

Results can be filtered by the optional filter. Pass None for no filter.

This function is blocking, so no async features are involved here. It is, however, safe to call this function in parallel, since the entire API client is thread-safe.

Trait Implementations

impl Default for Client

fn default() -> Self

Default Photon client, using https://photon.komoot.io for requests.