Struct geo_uri::GeoUri

pub struct GeoUri { /* private fields */ }

A uniform resource identifier for geographic locations (geo URI).

Examples

Parsing

You can get a GeoUri by converting it from a geo URI string (&str):

use geo_uri::GeoUri;

let geo_uri = GeoUri::try_from("geo:52.107,5.134,3.6;u=1000")?;
assert_eq!(geo_uri.latitude(), 52.107);
assert_eq!(geo_uri.longitude(), 5.134);
assert_eq!(geo_uri.altitude(), Some(3.6));
assert_eq!(geo_uri.uncertainty(), Some(1000.0));

or by calling the parse method on a string (using the TryFrom trait):

use geo_uri::GeoUri;

let geo_uri: GeoUri = "geo:52.107,5.134;u=2000.0".parse()?;
assert_eq!(geo_uri.latitude(), 52.107);
assert_eq!(geo_uri.longitude(), 5.134);
assert_eq!(geo_uri.altitude(), None);
assert_eq!(geo_uri.uncertainty(), Some(2000.0));

It is also possible to call the parse function directly:

use geo_uri::GeoUri;

let geo_uri = GeoUri::parse("geo:52.107,5.134,3.6")?;
assert_eq!(geo_uri.latitude(), 52.107);
assert_eq!(geo_uri.longitude(), 5.134);
assert_eq!(geo_uri.altitude(), Some(3.6));
assert_eq!(geo_uri.uncertainty(), None);

Generating

To get an geo URI string from some coordinates, use the GeoUriBuilder:

use geo_uri::GeoUri;

let geo_uri = GeoUri::builder()
    .latitude(52.107)
    .longitude(5.134)
    .uncertainty(1_000.0)
    .build()?;
assert_eq!(
    geo_uri.to_string(),
    String::from("geo:52.107,5.134;u=1000")
);
assert_eq!(
    format!("{geo_uri}"),
    String::from("geo:52.107,5.134;u=1000")
);

It is also possible to construct a GeoUri struct from coordinate tuples using the TryFrom trait:

use geo_uri::GeoUri;

let geo_uri = GeoUri::try_from((52.107, 5.134)).expect("valid coordinates");
let geo_uri = GeoUri::try_from((52.107, 5.134, 3.6)).expect("valid coordinates");

See also

For the proposed IEEE standard, see RFC 5870.

Implementations

impl GeoUri

pub fn builder() -> GeoUriBuilder

Return a builder for GeoUri.

pub fn parse(uri: &str) -> Result<Self, Error>

Try parsing a geo URI string into a GeoUri.

For the geo URI scheme syntax, see the propsed IEEE standard RFC 5870.

Errors

Will return an error if the parsing fails in any way.

pub fn latitude(&self) -> f64

Returns the latitude coordinate.

pub fn set_latitude(&mut self, latitude: f64) -> Result<(), Error>

Changes the latitude coordinate.

Errors

If the latitude is out of range for the coordinate reference system, an error will be returned.

pub fn longitude(&self) -> f64

Returns the longitude coordinate.

pub fn set_longitude(&mut self, longitude: f64) -> Result<(), Error>

Changes the longitude coordinate.

Errors

If the longitude is out of range for the coordinate reference system, an error will be returned.

pub fn altitude(&self) -> Option<f64>

Returns the altitude coordinate (if any).

pub fn set_altitude(&mut self, altitude: Option<f64>)

Changes the altitude coordinate.

pub fn uncertainty(&self) -> Option<f64>

Returns the uncertainty around the location.

pub fn set_uncertainty(&mut self, uncertainty: Option<f64>) -> Result<(), Error>

Changes the uncertainty around the location.

Errors

If the uncertainty distance is not zero or positive, an error will be returned.

Trait Implementations

impl Clone for GeoUri

fn clone(&self) -> GeoUri

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GeoUri

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

Formats the value using the given formatter.

impl Default for GeoUri

fn default() -> GeoUri

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GeoUri

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GeoUri

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

Formats the value using the given formatter.

impl From<&GeoUri> for Url

Available on crate feature url only.

fn from(geo_uri: &GeoUri) -> Self

Converts to this type from the input type.

impl From<GeoUri> for Url

Available on crate feature url only.

fn from(geo_uri: GeoUri) -> Self

Converts to this type from the input type.

impl FromStr for GeoUri

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for GeoUri

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

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

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

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

impl Serialize for GeoUri

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Url> for GeoUri

Available on crate feature url only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(url: &Url) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for GeoUri

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<(f64, f64)> for GeoUri

type Error = Error

The type returned in the event of a conversion error.

fn try_from((latitude, longitude): (f64, f64)) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<(f64, f64, f64)> for GeoUri

type Error = Error

The type returned in the event of a conversion error.

fn try_from( (latitude, longitude, altitude): (f64, f64, f64) ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Url> for GeoUri

Available on crate feature url only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(url: Url) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for GeoUri