Struct Coordinate

Source

pub struct Coordinate { /* private fields */ }

Expand description

A geographic coordinate expressed as a (latitude, longitude) pair.

§Examples

use lat_long::{Angle, Coordinate, Latitude, Longitude};

let lat = Latitude::new(51, 30, 26.0).unwrap();
let lon = Longitude::new(0, 7, 39.0).unwrap();
let london = Coordinate::new(lat, lon);

println!("{london}");   // decimal degrees
println!("{london:#}"); // degrees–minutes–seconds

Implementations§

Source §

impl Coordinate

Source

pub const fn new(lat: Latitude, long: Longitude) -> Self

Construct a new Coordinate from a validated Latitude and Longitude.

§Examples

use lat_long::{Angle, Coordinate, Latitude, Longitude};

let lat = Latitude::new(48, 51, 30.0).unwrap();
let lon = Longitude::new(2, 21, 8.0).unwrap();
let paris = Coordinate::new(lat, lon);
assert!(paris.is_northern());
assert!(paris.is_eastern());

Source

pub const fn with_latitude(self, lat: Latitude) -> Self

Return a new Coordinate with the latitude component replaced.

Source

pub const fn with_longitude(self, long: Longitude) -> Self

Return a new Coordinate with the longitude component replaced.

Source

pub const fn latitude(&self) -> Latitude

Returns the latitude component of this coordinate.

Source

pub const fn φ(&self) -> Latitude

Returns the latitude component of this coordinate.

Source

pub const fn longitude(&self) -> Longitude

Returns the longitude component of this coordinate.

Source

pub const fn λ(&self) -> Longitude

Returns the longitude component of this coordinate.

Source

pub fn is_on_equator(&self) -> bool

Returns true if this coordinate lies on the equator.

Source

pub fn is_northern(&self) -> bool

Returns true if this coordinate is in the northern hemisphere.

Source

pub fn is_southern(&self) -> bool

Returns true if this coordinate is in the southern hemisphere.

Source

pub fn is_on_international_reference_meridian(&self) -> bool

Returns true if this coordinate lies on the international reference meridian.

Source

pub fn is_western(&self) -> bool

Returns true if this coordinate is in the western hemisphere.

Source

pub fn is_eastern(&self) -> bool

Returns true if this coordinate is in the eastern hemisphere.

Source

pub fn to_url_string(&self) -> String

Format this coordinate as a geo: URI string.

The format is geo:<lat>,<lon> using decimal degrees with 8 places of precision, as per RFC 5870.

§Examples

use lat_long::{Angle, Coordinate, Latitude, Longitude};

let lat = Latitude::new(48, 51, 30.0).unwrap();
let lon = Longitude::new(2, 21, 8.0).unwrap();
let paris = Coordinate::new(lat, lon);
assert!(paris.to_url_string().starts_with("geo:"));

Source

pub fn to_microformat_string(&self) -> String

Format this coordinate as a microformat string.

This follows the microformat standard for representing coordinates specified in mf-geo and referenced by hCard and hCalendar.

§Examples

use lat_long::{Angle, Coordinate, Latitude, Longitude};

let lat = Latitude::new(48, 51, 30.0).unwrap();
let lon = Longitude::new(2, 21, 8.0).unwrap();
let paris = Coordinate::new(lat, lon);
assert!(paris.to_microformat_string().contains("class=\"latitude\""));
assert!(paris.to_microformat_string().contains("class=\"longitude\""));