Struct ichen_openprotocol::GeoLocation

pub struct GeoLocation {
    pub geo_latitude: f64,
    pub geo_longitude: f64,
}

A data structure containing a single physical geo-location.

Fields

geo_latitude: f64

Latitude

geo_longitude: f64

Longitude

Methods

impl GeoLocation

pub fn new(latitude: f64, longitude: f64) -> Self

Create a new GeoLocation.

Examples

// Notice this is an invalid geo-location position, but still works
// To validate the data structure, call the `validate` method.
let geo = GeoLocation::new(123.456, -987.654);
assert_eq!(123.456, geo.geo_latitude);
assert_eq!(-987.654, geo.geo_longitude);

pub fn validate(&self) -> Result<'static, ()>

Validate the data structure.

Errors

Returns Err(OpenProtocolError::InvalidField) if either geo_latitude or geo_longitude is not a valid floating-point number.

Returns Err(OpenProtocolError::ConstraintViolated) if geo_latitude and geo_longitude together does not represent a valid Geo-Location position.

Examples

let geo1 = GeoLocation::new(23.456, std::f64::NEG_INFINITY);
assert_eq!(
    r#"Err(InvalidField { field: "geo_longitude", value: "-inf", description: "Infinity is not a supported value" })"#,
    format!("{:?}", geo1.validate())
);

let geo2 = GeoLocation::new(123.456, 987.654);
assert_eq!(
    r#"Err(ConstraintViolated("latitude (123.456) must be between -90 and 90"))"#,
    format!("{:?}", geo2.validate())
);

Trait Implementations

impl PartialEq<GeoLocation> for GeoLocation

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for GeoLocation

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

Formats the value using the given formatter.

impl Serialize for GeoLocation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for GeoLocation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.