Struct Location 

pub struct Location { /* private fields */ }

A geographic location with coordinates and metadata.

All fields are private to allow future API evolution without breaking changes. Use the accessor methods to retrieve location data.

Implementations

impl Location

pub const fn new( latitude: Latitude, longitude: Longitude, timestamp: Timestamp, ) -> Location

Creates a new Location with validated coordinates.

Arguments

• latitude - Latitude in degrees (-90 to 90).
• longitude - Longitude in degrees (-180 to 180).
• timestamp - When this location was recorded

pub fn from_degrees( latitude: f64, longitude: f64, timestamp: Timestamp, ) -> Result<Location, LocationError>

Creates a new Location from raw coordinate degrees.

Errors

Returns LocationError::InvalidCoordinate if either coordinate is NaN or outside its valid range.

pub async fn get() -> Result<Location, LocationError>

Returns the current device location.

Precondition: callers must ensure Permission::Location is granted; this function does not trigger the runtime prompt. Use waterkit_permission::request(Permission::Location) first.

Errors

Returns LocationError::PermissionDenied when access is denied, LocationError::ServiceDisabled when location services are off, LocationError::Timeout when the request times out, LocationError::InvalidCoordinate when the OS returns invalid coordinates, or LocationError::Platform for other OS failures.

pub const fn with_altitude(self, altitude: f64) -> Location

Sets the altitude in meters above sea level.

with_* prefix is preserved here because Location also has getters with bare field names (altitude() returns the current value); the workspace-wide naming rule is “bare method name = setter unless a getter already takes that name.”

pub const fn with_horizontal_accuracy(self, accuracy: f64) -> Location

Sets the horizontal accuracy in meters.

pub const fn with_vertical_accuracy(self, accuracy: f64) -> Location

Sets the vertical accuracy in meters.

pub const fn latitude(&self) -> Latitude

Returns the latitude in degrees (-90 to 90).

pub const fn longitude(&self) -> Longitude

Returns the longitude in degrees (-180 to 180).

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

Returns the altitude in meters above sea level, if available.

pub const fn horizontal_accuracy(&self) -> Option<f64>

Returns the horizontal accuracy in meters, if available.

Lower values indicate more precise location data.

pub const fn vertical_accuracy(&self) -> Option<f64>

Returns the vertical accuracy in meters, if available.

Lower values indicate more precise altitude data.

pub const fn timestamp(&self) -> Timestamp

Returns the timestamp when this location was recorded.

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Location

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

Formats the value using the given formatter.

impl From<&Location> for Coordinate

fn from(value: &Location) -> Self

Converts to this type from the input type.

impl From<Location> for Coordinate

fn from(value: Location) -> Self

Converts to this type from the input type.

impl PartialEq for Location

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Location