Struct Client

pub struct Client {
    pub timeout: Duration,
    /* private fields */
}

The interface for accessing a Nominatim API server.

Fields

timeout: Duration

HTTP Request Timeout Duration

Implementations

impl Client

pub fn new(ident: IdentificationMethod) -> Self

Create a new Client from an IdentificationMethod.

pub fn set_base_url<U: TryInto<Url>>(&mut self, url: U) -> Result<(), U::Error>

Set the client’s internal base url for all requests.

pub async fn status(&self) -> Result<Status, Error>

Check the status of the nominatim server.

Documentation

pub async fn search(&self, query: impl AsRef<str>) -> Result<Vec<Place>, Error>

Get Places from a search query.

Documentation

pub async fn reverse( &self, latitude: impl AsRef<str>, longitude: impl AsRef<str>, zoom: Option<u8>, ) -> Result<Place, Error>

Generate a Place from latitude and longitude.

Documentation

pub async fn lookup(&self, queries: Vec<&str>) -> Result<Vec<Place>, Error>

Return Places from a list of OSM Node, Way, or Relations.

Documentation

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.