1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
//! # Examples
//!
//! ```rust,no_run
//! use ashpd::{
//! desktop::location::{Accuracy, LocationProxy},
//! WindowIdentifier,
//! };
//! use futures_util::{FutureExt, StreamExt};
//!
//! async fn run() -> ashpd::Result<()> {
//! let proxy = LocationProxy::new().await?;
//! let identifier = WindowIdentifier::default();
//! let session = proxy
//! .create_session(None, None, Some(Accuracy::Street))
//! .await?;
//! let mut stream = proxy.receive_location_updated().await?;
//! let (_, location) = futures_util::join!(
//! proxy
//! .start(&session, &identifier)
//! .map(|e| e.expect("Couldn't start session")),
//! stream.next().map(|e| e.expect("Stream is exhausted"))
//! );
//! println!("{}", location.accuracy());
//! println!("{}", location.longitude());
//! println!("{}", location.latitude());
//! session.close().await?;
//! Ok(())
//! }
//! ```
use std::fmt::Debug;
use futures_util::{Stream, TryFutureExt};
use serde::Deserialize;
use serde_repr::Serialize_repr;
use zbus::zvariant::{DeserializeDict, ObjectPath, OwnedObjectPath, SerializeDict, Type};
use super::{session::SessionPortal, HandleToken, Request, Session};
use crate::{proxy::Proxy, Error, WindowIdentifier};
#[cfg_attr(feature = "glib", derive(glib::Enum))]
#[cfg_attr(feature = "glib", enum_type(name = "AshpdLocationAccuracy"))]
#[derive(Serialize_repr, PartialEq, Eq, Clone, Copy, Debug, Type)]
#[doc(alias = "XdpLocationAccuracy")]
#[repr(u32)]
/// The accuracy of the location.
pub enum Accuracy {
#[doc(alias = "XDP_LOCATION_ACCURACY_NONE")]
/// None.
None = 0,
#[doc(alias = "XDP_LOCATION_ACCURACY_COUNTRY")]
/// Country.
Country = 1,
#[doc(alias = "XDP_LOCATION_ACCURACY_CITY")]
/// City.
City = 2,
#[doc(alias = "XDP_LOCATION_ACCURACY_NEIGHBORHOOD")]
/// Neighborhood.
Neighborhood = 3,
#[doc(alias = "XDP_LOCATION_ACCURACY_STREET")]
/// Street.
Street = 4,
#[doc(alias = "XDP_LOCATION_ACCURACY_EXACT")]
/// The exact location.
Exact = 5,
}
#[derive(SerializeDict, Type, Debug, Default)]
/// Specified options for a [`LocationProxy::create_session`] request.
#[zvariant(signature = "dict")]
struct CreateSessionOptions {
/// A string that will be used as the last element of the session handle.
session_handle_token: HandleToken,
/// Distance threshold in meters. Default is 0.
#[zvariant(rename = "distance-threshold")]
distance_threshold: Option<u32>,
/// Time threshold in seconds. Default is 0.
#[zvariant(rename = "time-threshold")]
time_threshold: Option<u32>,
/// Requested accuracy. Default is `Accuracy::Exact`.
accuracy: Option<Accuracy>,
}
#[derive(SerializeDict, Type, Debug, Default)]
/// Specified options for a [`LocationProxy::start`] request.
#[zvariant(signature = "dict")]
struct SessionStartOptions {
/// A string that will be used as the last element of the handle.
handle_token: HandleToken,
}
#[derive(Deserialize, Type)]
/// The response received on a `location_updated` signal.
pub struct Location(OwnedObjectPath, LocationInner);
impl Location {
/// The associated session.
pub fn session_handle(&self) -> ObjectPath<'_> {
self.0.as_ref()
}
/// The accuracy, in meters.
pub fn accuracy(&self) -> f64 {
self.1.accuracy
}
/// The altitude, in meters.
pub fn altitude(&self) -> Option<f64> {
if self.1.altitude == -f64::MAX {
None
} else {
Some(self.1.altitude)
}
}
/// The speed, in meters per second.
pub fn speed(&self) -> Option<f64> {
if self.1.speed == -1f64 {
None
} else {
Some(self.1.speed)
}
}
/// The heading, in degrees, going clockwise. North 0, East 90, South 180,
/// West 270.
pub fn heading(&self) -> Option<f64> {
if self.1.heading == -1f64 {
None
} else {
Some(self.1.heading)
}
}
/// The location description.
pub fn description(&self) -> Option<&str> {
if self.1.description.is_empty() {
None
} else {
Some(&self.1.description)
}
}
/// The latitude, in degrees.
pub fn latitude(&self) -> f64 {
self.1.latitude
}
/// The longitude, in degrees.
pub fn longitude(&self) -> f64 {
self.1.longitude
}
/// The timestamp when the location was retrieved.
pub fn timestamp(&self) -> std::time::Duration {
std::time::Duration::from_secs(self.1.timestamp.0)
}
}
impl Debug for Location {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Location")
.field("accuracy", &self.accuracy())
.field("altitude", &self.altitude())
.field("speed", &self.speed())
.field("heading", &self.heading())
.field("description", &self.description())
.field("latitude", &self.latitude())
.field("longitude", &self.longitude())
.field("timestamp", &self.timestamp())
.finish()
}
}
#[derive(Debug, SerializeDict, DeserializeDict, Type)]
#[zvariant(signature = "dict")]
struct LocationInner {
#[zvariant(rename = "Accuracy")]
accuracy: f64,
#[zvariant(rename = "Altitude")]
altitude: f64,
#[zvariant(rename = "Speed")]
speed: f64,
#[zvariant(rename = "Heading")]
heading: f64,
#[zvariant(rename = "Description")]
description: String,
#[zvariant(rename = "Latitude")]
latitude: f64,
#[zvariant(rename = "Longitude")]
longitude: f64,
#[zvariant(rename = "Timestamp")]
timestamp: (u64, u64),
}
/// The interface lets sandboxed applications query basic information about the
/// location.
///
/// Wrapper of the DBus interface: [`org.freedesktop.portal.Location`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Location.html).
#[derive(Debug)]
#[doc(alias = "org.freedesktop.portal.Location")]
pub struct LocationProxy<'a>(Proxy<'a>);
impl<'a> LocationProxy<'a> {
/// Create a new instance of [`LocationProxy`].
pub async fn new() -> Result<LocationProxy<'a>, Error> {
let proxy = Proxy::new_desktop("org.freedesktop.portal.Location").await?;
Ok(Self(proxy))
}
/// Signal emitted when the user location is updated.
///
/// # Specifications
///
/// See also [`LocationUpdated`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Location.html#org-freedesktop-portal-location-locationupdated).
#[doc(alias = "LocationUpdated")]
#[doc(alias = "XdpPortal::location-updated")]
pub async fn receive_location_updated(&self) -> Result<impl Stream<Item = Location>, Error> {
self.0.signal("LocationUpdated").await
}
/// Create a location session.
///
/// # Arguments
///
/// * `distance_threshold` - Sets the distance threshold in meters, default
/// to `0`.
/// * `time_threshold` - Sets the time threshold in seconds, default to `0`.
/// * `accuracy` - Sets the location accuracy, default to
/// [`Accuracy::Exact`].
///
/// # Specifications
///
/// See also [`CreateSession`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Location.html#org-freedesktop-portal-location-createsession).
#[doc(alias = "CreateSession")]
pub async fn create_session(
&self,
distance_threshold: Option<u32>,
time_threshold: Option<u32>,
accuracy: Option<Accuracy>,
) -> Result<Session<'a, Self>, Error> {
let options = CreateSessionOptions {
distance_threshold,
time_threshold,
accuracy,
..Default::default()
};
let (path, proxy) = futures_util::try_join!(
self.0
.call::<OwnedObjectPath>("CreateSession", &(options))
.into_future(),
Session::from_unique_name(&options.session_handle_token).into_future(),
)?;
assert_eq!(proxy.path(), &path.into_inner());
Ok(proxy)
}
/// Start the location session.
/// An application can only attempt start a session once.
///
/// # Arguments
///
/// * `session` - A [`Session`], created with
/// [`create_session()`][`LocationProxy::create_session`].
/// * `identifier` - Identifier for the application window.
///
/// # Specifications
///
/// See also [`Start`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Location.html#org-freedesktop-portal-location-start).
#[doc(alias = "Start")]
#[doc(alias = "xdp_portal_location_monitor_start")]
pub async fn start(
&self,
session: &Session<'_, Self>,
identifier: &WindowIdentifier,
) -> Result<Request<()>, Error> {
let options = SessionStartOptions::default();
self.0
.empty_request(
&options.handle_token,
"Start",
&(session, &identifier, &options),
)
.await
}
}
impl SessionPortal for LocationProxy<'_> {}
impl<'a> std::ops::Deref for LocationProxy<'a> {
type Target = zbus::Proxy<'a>;
fn deref(&self) -> &Self::Target {
&self.0
}
}