Struct Engine

pub struct Engine<'a> {
    pub data: &'a ArchivedIndexData,
}

Fields

data: &'a ArchivedIndexData

Implementations

impl Engine<'_>

pub fn get(&self, id: &u32) -> Option<&ArchivedCitiesRecord>

pub fn capital(&self, country_code: &str) -> Option<&ArchivedCitiesRecord>

Get capital by uppercase country code

pub fn suggest<T: AsRef<str>>( &self, pattern: &str, limit: usize, min_score: Option<f32>, countries: Option<&[T]>, ) -> Vec<&ArchivedCitiesRecord>

Suggest cities by pattern (multilang).

Optional: filter by Jaro–Winkler distance via min_score

Optional: prefilter by countries

pub fn reverse<T: AsRef<str>>( &self, loc: (f32, f32), limit: usize, k: Option<f32>, countries: Option<&[T]>, ) -> Option<Vec<ArchivedReverseItem<'_>>>

Find the nearest cities by coordinates.

Optional: score results by k as distance - k * city.population and sort by score.

Optional: prefilter by countries. It’s a very expensive case; consider building an index for concrete countries and not applying this filter at all.

pub fn country_info(&self, country_code: &str) -> Option<&ArchivedCountryRecord>

Get country info by iso 2-letter country code.