Struct leptos_use::UseGeolocationOptions

pub struct UseGeolocationOptions { /* private fields */ }

Options for use_geolocation_with_options.

Implementations

impl UseGeolocationOptions

pub fn immediate(self, value: bool) -> Self

If true the geolocation watch is started when this function is called. If false you have to call resume manually to start it. Defaults to true.

pub fn enable_high_accuracy(self, value: bool) -> Self

A boolean value that indicates the application would like to receive the best possible results. If true and if the device is able to provide a more accurate position, it will do so. Note that this can result in slower response times or increased power consumption (with a GPS chip on a mobile device for example). On the other hand, if false, the device can take the liberty to save resources by responding more quickly and/or using less power. Default: false.

pub fn maximum_age(self, value: u32) -> Self

A positive value indicating the maximum age in milliseconds of a possible cached position that is acceptable to return. If set to 0, it means that the device cannot use a cached position and must attempt to retrieve the real current position. Default: 30000.

pub fn timeout(self, value: u32) -> Self

A positive value representing the maximum length of time (in milliseconds) the device is allowed to take in order to return a position. The default value is 27000.

Trait Implementations

impl Clone for UseGeolocationOptions

fn clone(&self) -> UseGeolocationOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for UseGeolocationOptions

fn default() -> Self

Returns the “default value” for a type.