Struct egg_mode::place::GeocodeBuilder

pub struct GeocodeBuilder { /* fields omitted */ }

Represents a reverse_geocode query before it is sent.

The available methods on this builder struct allow you to specify optional parameters to the search operation. Where applicable, each method lists its default value and acceptable ranges.

To complete your search setup and send the query to Twitter, hand your tokens to call. The list of results from Twitter will be returned, as well as a URL to perform the same search via reverse_geocode_url.

Methods

impl GeocodeBuilder

fn accuracy(self, accuracy: Accuracy) -> Self

Expands the area to search to the given radius. By default, this is zero.

From Twitter: "If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.)."

fn granularity(self, granularity: PlaceType) -> Self

Sets the minimal specificity of what kind of results to return. For example, passing City to this will make the eventual result exclude neighborhoods and points.

fn max_results(self, max_results: u32) -> Self

Restricts the maximum number of results returned in this search. This is not a guarantee that the search will return this many results, but instead provides a hint as to how many "nearby" results to return.

This value has a default value of 20, which is also its maximum. If zero or a number greater than 20 is passed here, it will be defaulted to 20 before sending to Twitter.

From Twitter: "Ideally, only pass in the number of places you intend to display to the user here."

fn call<'a>(
    &self,
    token: &Token,
    handle: &'a Handle
) -> FutureResponse<'a, SearchResult>

Finalize the search parameters and return the results collection.