Skip to main content

Manager

Struct Manager 

Source
pub struct Manager { /* private fields */ }
Expand description

A manager for dealing with location data and handling location updates.

All functions must be called from the main thread, except on Linux, where any thread works (including from inside a handler callback).

As soon as the handler is registered, it may receive updates immediately, even if update_once or start_updates are not called. When the manager is dropped, the handler is no longer guaranteed to receive updates.

Implementations§

Source§

impl Manager

Source

pub fn new<T>(handler: T) -> Result<Self>
where T: Handler,

Creates a new location manager with the given handler.

Must be called from the main thread, except on Linux.

Source

pub fn new_with_desktop_id<T>(handler: T, desktop_id: &str) -> Result<Self>
where T: Handler,

Like Manager::new, but with an explicit GeoClue desktop ID.

Prefer Manager::new, which works this out itself. This is an escape hatch for odd or legacy GeoClue setups. Pass an installed desktop-file ID without the .desktop suffix (ASCII letters, digits, ., _, -); it’s validated either way.

Available everywhere so cross-platform code can call it unconditionally; off Linux the ID is ignored.

Source

pub fn request_authorization( &self, access: Access, accuracy: Accuracy, ) -> Result<()>

Requests authorization to access location data.

Linux (portal), iOS, and Android return immediately; a request made beforehand waits for the user, and a denial goes to Handler::error. Linux (GeoClue) and Windows block and return the result.

Source

pub fn update_once(&self) -> Result<()>

Requests the device’s current location, delivered to the handler. May deliver a cached fix immediately, then a fresher one once acquired. On Linux, gives up after 60 seconds with Error::TemporarilyUnavailable if nothing arrives.

Source

pub fn start_updates(&mut self) -> Result<()>

Begins delivering continuous updates to the handler.

Source

pub fn stop_updates(&mut self) -> Result<()>

Stops delivering continuous updates to the handler.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more