Struct Geoname

pub struct Geoname {
    pub geoname_id: i64,
    pub geoname_type: GeonameType,
    pub name: String,
    pub country_code: String,
    pub feature_class: String,
    pub feature_code: String,
    pub admin_division_codes: HashMap<u8, String>,
    pub population: u64,
    pub latitude: String,
    pub longitude: String,
}

A single geographic place.

This corresponds to a single row in the main “geoname” table described in the GeoNames documentation 1. We exclude fields we don’t need.

Fields

geoname_id: i64

The geonameid straight from the geoname table.

geoname_type: GeonameType

The geoname type. This is derived from feature_class and feature_code as a more convenient representation of the type.

name: String

The place’s primary name.

country_code: String

ISO-3166 two-letter uppercase country code, e.g., “US”.

feature_class: String

Primary geoname category. Examples:

“PCLI” - Independent political entity: country “A” - Administrative division: state, province, borough, district, etc. “P” - Populated place: city, village, etc.

feature_code: String

Secondary geoname category, depends on feature_class. Examples:

“ADM1” - Administrative division 1 “PPL” - Populated place like a city

admin_division_codes: HashMap<u8, String>

Administrative divisions. This maps admin division levels (1-based) to their corresponding codes. For example, Liverpool has two admin divisions: “ENG” at level 1 and “H8” at level 2. They would be represented in this map with entries (1, "ENG") and (2, "H8").

population: u64

Population size.

latitude: String

Latitude in decimal degrees (as a string).

longitude: String

Longitude in decimal degrees (as a string).

Implementations

impl Geoname

pub fn is_related_to(&self, other: &Self) -> bool

Whether self and other are related. For example, if one is a city and the other is an administrative division, this will return true if the city is located in the division.

Trait Implementations

impl Clone for Geoname

fn clone(&self) -> Geoname

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for Geoname

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for Geoname

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for Geoname

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl Hash for Geoname

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<UT> Lift<UT> for Geoname

type FfiType = <Geoname as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for Geoname

type LiftType = Geoname

impl<UT> LiftReturn<UT> for Geoname

type ReturnType = <Geoname as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for Geoname

type FfiType = <Geoname as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for Geoname

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for Geoname

type ReturnType = <Geoname as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl PartialEq for Geoname

fn eq(&self, other: &Geoname) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<UT> TypeId<UT> for Geoname

const TYPE_ID_META: MetadataBuffer

impl Eq for Geoname

impl StructuralPartialEq for Geoname