Struct web_sys::Navigator

pub struct Navigator { /* private fields */ }

The Navigator class.

MDN Documentation

This API requires the following crate features to be activated: Navigator

Implementations

impl Navigator

pub fn clipboard(&self) -> Clipboard

Getter for the clipboard field of this object.

MDN Documentation

This API requires the following crate features to be activated: Clipboard, Navigator

impl Navigator

pub fn permissions(&self) -> Result<Permissions, JsValue>

Getter for the permissions field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, Permissions

impl Navigator

pub fn mime_types(&self) -> Result<MimeTypeArray, JsValue>

Getter for the mimeTypes field of this object.

MDN Documentation

This API requires the following crate features to be activated: MimeTypeArray, Navigator

impl Navigator

pub fn plugins(&self) -> Result<PluginArray, JsValue>

Getter for the plugins field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, PluginArray

impl Navigator

pub fn do_not_track(&self) -> String

Getter for the doNotTrack field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn max_touch_points(&self) -> i32

Getter for the maxTouchPoints field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn media_capabilities(&self) -> MediaCapabilities

Getter for the mediaCapabilities field of this object.

MDN Documentation

This API requires the following crate features to be activated: MediaCapabilities, Navigator

impl Navigator

pub fn connection(&self) -> Result<NetworkInformation, JsValue>

Getter for the connection field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, NetworkInformation

impl Navigator

pub fn active_vr_displays(&self) -> Array

Getter for the activeVRDisplays field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn media_devices(&self) -> Result<MediaDevices, JsValue>

Getter for the mediaDevices field of this object.

MDN Documentation

This API requires the following crate features to be activated: MediaDevices, Navigator

impl Navigator

pub fn service_worker(&self) -> ServiceWorkerContainer

Getter for the serviceWorker field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, ServiceWorkerContainer

impl Navigator

pub fn presentation(&self) -> Result<Option<Presentation>, JsValue>

Getter for the presentation field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, Presentation

impl Navigator

pub fn credentials(&self) -> CredentialsContainer

Getter for the credentials field of this object.

MDN Documentation

This API requires the following crate features to be activated: CredentialsContainer, Navigator

impl Navigator

pub fn user_activation(&self) -> UserActivation

Getter for the userActivation field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, UserActivation

impl Navigator

pub fn bluetooth(&self) -> Option<Bluetooth>

Getter for the bluetooth field of this object.

MDN Documentation

This API requires the following crate features to be activated: Bluetooth, Navigator

This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as described in the wasm-bindgen guide

impl Navigator

pub fn media_session(&self) -> MediaSession

Getter for the mediaSession field of this object.

MDN Documentation

This API requires the following crate features to be activated: MediaSession, Navigator

This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as described in the wasm-bindgen guide

impl Navigator

pub fn wake_lock(&self) -> WakeLock

Getter for the wakeLock field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, WakeLock

This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as described in the wasm-bindgen guide

impl Navigator

pub fn hid(&self) -> Hid

Getter for the hid field of this object.

MDN Documentation

This API requires the following crate features to be activated: Hid, Navigator

This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as described in the wasm-bindgen guide

impl Navigator

pub fn serial(&self) -> Serial

Getter for the serial field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, Serial

This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as described in the wasm-bindgen guide

impl Navigator

pub fn usb(&self) -> Usb

Getter for the usb field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, Usb

This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as described in the wasm-bindgen guide

impl Navigator

pub fn xr(&self) -> XrSystem

Getter for the xr field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, XrSystem

This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as described in the wasm-bindgen guide

impl Navigator

pub fn scheduling(&self) -> Scheduling

Getter for the scheduling field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, Scheduling

This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as described in the wasm-bindgen guide

impl Navigator

pub fn hardware_concurrency(&self) -> f64

Getter for the hardwareConcurrency field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn device_memory(&self) -> f64

Getter for the deviceMemory field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as described in the wasm-bindgen guide

impl Navigator

pub fn gpu(&self) -> Gpu

Getter for the gpu field of this object.

MDN Documentation

This API requires the following crate features to be activated: Gpu, Navigator

This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as described in the wasm-bindgen guide

impl Navigator

pub fn geolocation(&self) -> Result<Geolocation, JsValue>

Getter for the geolocation field of this object.

MDN Documentation

This API requires the following crate features to be activated: Geolocation, Navigator

impl Navigator

pub fn app_code_name(&self) -> Result<String, JsValue>

Getter for the appCodeName field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn app_name(&self) -> String

Getter for the appName field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn app_version(&self) -> Result<String, JsValue>

Getter for the appVersion field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn platform(&self) -> Result<String, JsValue>

Getter for the platform field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn user_agent(&self) -> Result<String, JsValue>

Getter for the userAgent field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn product(&self) -> String

Getter for the product field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn language(&self) -> Option<String>

Getter for the language field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn languages(&self) -> Array

Getter for the languages field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn locks(&self) -> LockManager

Getter for the locks field of this object.

MDN Documentation

This API requires the following crate features to be activated: LockManager, Navigator

This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as described in the wasm-bindgen guide

impl Navigator

pub fn on_line(&self) -> bool

Getter for the onLine field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn storage(&self) -> StorageManager

Getter for the storage field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, StorageManager

impl Navigator

pub fn user_agent_data(&self) -> NavigatorUaData

Getter for the userAgentData field of this object.

MDN Documentation

This API requires the following crate features to be activated: Navigator, NavigatorUaData

This API is unstable and requires --cfg=web_sys_unstable_apis to be activated, as described in the wasm-bindgen guide

impl Navigator

pub fn can_share(&self) -> bool

The canShare() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn can_share_with_data(&self, data: &ShareData) -> bool

The canShare() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator, ShareData

impl Navigator

pub fn get_gamepads(&self) -> Result<Array, JsValue>

The getGamepads() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn get_vr_displays(&self) -> Result<Promise, JsValue>

The getVRDisplays() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn request_gamepad_service_test(&self) -> GamepadServiceTest

The requestGamepadServiceTest() method.

MDN Documentation

This API requires the following crate features to be activated: GamepadServiceTest, Navigator

impl Navigator

pub fn request_midi_access(&self) -> Result<Promise, JsValue>

The requestMIDIAccess() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn request_midi_access_with_options( &self, options: &MidiOptions, ) -> Result<Promise, JsValue>

The requestMIDIAccess() method.

MDN Documentation

This API requires the following crate features to be activated: MidiOptions, Navigator

impl Navigator

pub fn request_media_key_system_access( &self, key_system: &str, supported_configurations: &JsValue, ) -> Promise

The requestMediaKeySystemAccess() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn request_vr_service_test(&self) -> VrServiceTest

The requestVRServiceTest() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator, VrServiceTest

impl Navigator

pub fn send_beacon(&self, url: &str) -> Result<bool, JsValue>

The sendBeacon() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn send_beacon_with_opt_blob( &self, url: &str, data: Option<&Blob>, ) -> Result<bool, JsValue>

The sendBeacon() method.

MDN Documentation

This API requires the following crate features to be activated: Blob, Navigator

impl Navigator

pub fn send_beacon_with_opt_buffer_source( &self, url: &str, data: Option<&Object>, ) -> Result<bool, JsValue>

The sendBeacon() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn send_beacon_with_opt_u8_array( &self, url: &str, data: Option<&mut [u8]>, ) -> Result<bool, JsValue>

The sendBeacon() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn send_beacon_with_opt_form_data( &self, url: &str, data: Option<&FormData>, ) -> Result<bool, JsValue>

The sendBeacon() method.

MDN Documentation

This API requires the following crate features to be activated: FormData, Navigator

impl Navigator

pub fn send_beacon_with_opt_url_search_params( &self, url: &str, data: Option<&UrlSearchParams>, ) -> Result<bool, JsValue>

The sendBeacon() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator, UrlSearchParams

impl Navigator

pub fn send_beacon_with_opt_str( &self, url: &str, data: Option<&str>, ) -> Result<bool, JsValue>

The sendBeacon() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn send_beacon_with_opt_readable_stream( &self, url: &str, data: Option<&ReadableStream>, ) -> Result<bool, JsValue>

The sendBeacon() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator, ReadableStream

impl Navigator

pub fn share(&self) -> Promise

The share() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn share_with_data(&self, data: &ShareData) -> Promise

The share() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator, ShareData

impl Navigator

pub fn vibrate_with_duration(&self, pattern: u32) -> bool

The vibrate() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn vibrate_with_pattern(&self, pattern: &JsValue) -> bool

The vibrate() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn register_content_handler( &self, mime_type: &str, url: &str, title: &str, ) -> Result<(), JsValue>

The registerContentHandler() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn register_protocol_handler( &self, scheme: &str, url: &str, title: &str, ) -> Result<(), JsValue>

The registerProtocolHandler() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

impl Navigator

pub fn taint_enabled(&self) -> bool

The taintEnabled() method.

MDN Documentation

This API requires the following crate features to be activated: Navigator

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

pub fn has_own_property(&self, property: &JsValue) -> bool

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue = _

pub const UNDEFINED: JsValue = _

pub const TRUE: JsValue = _

pub const FALSE: JsValue = _

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<JsValue> for Navigator

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Navigator> for Navigator

fn as_ref(&self) -> &Navigator

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Object> for Navigator

fn as_ref(&self) -> &Object

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Navigator

fn clone(&self) -> Navigator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Navigator

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

Formats the value using the given formatter.

impl Deref for Navigator

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl From<JsValue> for Navigator

fn from(obj: JsValue) -> Navigator

Converts to this type from the input type.

impl From<Navigator> for JsValue

fn from(obj: Navigator) -> JsValue

Converts to this type from the input type.

impl From<Navigator> for Object

fn from(obj: Navigator) -> Object

Converts to this type from the input type.

impl FromWasmAbi for Navigator

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a Navigator

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for Navigator

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for Navigator

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl LongRefFromWasmAbi for Navigator

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = Navigator

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Navigator

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a Navigator

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for Navigator

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl PartialEq for Navigator

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefFromWasmAbi for Navigator

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Navigator>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for Navigator

fn describe()

impl Eq for Navigator

impl StructuralPartialEq for Navigator