Struct web_sys::Window[−][src]

#[repr(transparent)]
pub struct Window { /* fields omitted */ }

The Window class.

`pub const NULL: JsValue`[src]

`pub const UNDEFINED: JsValue`[src]

`pub const TRUE: JsValue`[src]

`pub const FALSE: JsValue`[src]

`pub fn as_f64(&self) -> Option<f64>`[src]

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`[src]

Tests whether this JS value is a JS string.

`pub fn as_string(&self) -> Option<String>`[src]

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>`[src]

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`[src]

Tests whether this JS value is null

`pub fn is_undefined(&self) -> bool`[src]

Tests whether this JS value is undefined

`pub fn is_symbol(&self) -> bool`[src]

Tests whether the type of this JS value is symbol

`pub fn is_object(&self) -> bool`[src]

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

`pub fn is_function(&self) -> bool`[src]

Tests whether the type of this JS value is function.

`pub fn is_truthy(&self) -> bool`[src]

Tests whether the value is “truthy”.

`pub fn is_falsy(&self) -> bool`[src]

Tests whether the value is “falsy”.

Trait Implementations

`impl AsRef<EventTarget> for Window`[src]

`fn as_ref(&self) -> &EventTarget`[src]

Performs the conversion.

`impl AsRef<JsValue> for Window`[src]

`fn as_ref(&self) -> &JsValue`[src]

Performs the conversion.

`impl AsRef<Object> for Window`[src]

`fn as_ref(&self) -> &Object`[src]

Performs the conversion.

`impl AsRef<Window> for Window`[src]

`fn as_ref(&self) -> &Window`[src]

Performs the conversion.

`impl Clone for Window`[src]

`fn clone(&self) -> Window`[src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from source. Read more

`impl Debug for Window`[src]

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

Formats the value using the given formatter. Read more

`impl Deref for Window`[src]

`type Target = EventTarget`

`unsafe fn from_abi(js: Self::Abi) -> Self`[src]

Recover a Self from Self::Abi. Read more

`impl IntoWasmAbi for Window`[src]

`type Abi = <JsValue as IntoWasmAbi>::Abi`

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

`fn into_abi(self) -> Self::Abi`[src]

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

`impl<'a> IntoWasmAbi for &'a Window`[src]

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

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

`fn into_abi(self) -> Self::Abi`[src]

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

`impl JsCast for Window`[src]

`fn instanceof(val: &JsValue) -> bool`[src]

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

`fn unchecked_from_js(val: JsValue) -> Self`[src]

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

`fn unchecked_from_js_ref(val: &JsValue) -> &Self`[src]

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

`fn has_type<T>(&self) -> bool where T: JsCast,` [src]

Test whether this JS value has a type T. Read more

`fn dyn_into<T>(self) -> Result<T, Self> where T: JsCast,` [src]

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

`fn dyn_ref<T>(&self) -> Option<&T> where T: JsCast,` [src]

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

`fn unchecked_into<T>(self) -> T where T: JsCast,` [src]

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

`fn unchecked_ref<T>(&self) -> &T where T: JsCast,` [src]

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

`fn is_instance_of<T>(&self) -> bool where T: JsCast,` [src]

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

`fn is_type_of(val: &JsValue) -> bool`[src]

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

`impl OptionFromWasmAbi for Window`[src]

`fn is_none(abi: &Self::Abi) -> bool`[src]

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

`impl OptionIntoWasmAbi for Window`[src]

`fn none() -> Self::Abi`[src]

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

`impl<'a> OptionIntoWasmAbi for &'a Window`[src]

`fn none() -> Self::Abi`[src]

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

`impl PartialEq<Window> for Window`[src]

`fn eq(&self, other: &Window) -> bool`[src]

This method tests for self and other values to be equal, and is used by ==. Read more

`fn ne(&self, other: &Window) -> bool`[src]

This method tests for !=.

`impl RefFromWasmAbi for Window`[src]

`type Abi = <JsValue as RefFromWasmAbi>::Abi`

The wasm ABI type references to Self are recovered from.

`type Anchor = ManuallyDrop<Window>`

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. Read more

`unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor`[src]

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

`impl WasmDescribe for Window`[src]

`fn describe()`[src]

`impl Eq for Window`[src]

`impl StructuralEq for Window`[src]

`impl StructuralPartialEq for Window`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Window`

`impl !Send for Window`

`impl !Sync for Window`

`impl Unpin for Window`

`impl UnwindSafe for Window`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

Gets the TypeId of self. Read more

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

Performs the conversion.

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

Performs the conversion.

`impl<T> ReturnWasmAbi for T where T: IntoWasmAbi,` [src]

`type Abi = <T as IntoWasmAbi>::Abi`

Same as IntoWasmAbi::Abi

`pub fn return_abi(self) -> <T as ReturnWasmAbi>::Abi`[src]

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err. Read more

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

`pub fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

Performs the conversion.

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, >::Error>`[src]

Performs the conversion.

Struct web_sys::Window⎘[−][src]

Implementations

impl Window[src]

pub fn window(&self) -> Window[src]

impl Window[src]

pub fn self_(&self) -> Window[src]

impl Window[src]

pub fn document(&self) -> Option<Document>[src]

impl Window[src]

pub fn name(&self) -> Result<String, JsValue>[src]

impl Window[src]

pub fn set_name(&self, value: &str) -> Result<(), JsValue>[src]

impl Window[src]

pub fn location(&self) -> Location[src]

impl Window[src]

pub fn history(&self) -> Result<History, JsValue>[src]

impl Window[src]

pub fn custom_elements(&self) -> CustomElementRegistry[src]

impl Window[src]

pub fn locationbar(&self) -> Result<BarProp, JsValue>[src]

impl Window[src]

pub fn menubar(&self) -> Result<BarProp, JsValue>[src]

impl Window[src]

pub fn personalbar(&self) -> Result<BarProp, JsValue>[src]

impl Window[src]

pub fn scrollbars(&self) -> Result<BarProp, JsValue>[src]

impl Window[src]

pub fn statusbar(&self) -> Result<BarProp, JsValue>[src]

impl Window[src]

pub fn toolbar(&self) -> Result<BarProp, JsValue>[src]

impl Window[src]

pub fn status(&self) -> Result<String, JsValue>[src]

impl Window[src]

pub fn set_status(&self, value: &str) -> Result<(), JsValue>[src]

impl Window[src]

pub fn closed(&self) -> Result<bool, JsValue>[src]

impl Window[src]

pub fn event(&self) -> JsValue[src]

impl Window[src]

pub fn frames(&self) -> Result<Window, JsValue>[src]

impl Window[src]

pub fn length(&self) -> u32[src]

impl Window[src]

pub fn top(&self) -> Result<Option<Window>, JsValue>[src]

impl Window[src]

pub fn opener(&self) -> Result<JsValue, JsValue>[src]

impl Window[src]

pub fn set_opener(&self, value: &JsValue) -> Result<(), JsValue>[src]

impl Window[src]

pub fn parent(&self) -> Result<Option<Window>, JsValue>[src]

impl Window[src]

pub fn frame_element(&self) -> Result<Option<Element>, JsValue>[src]

impl Window[src]

pub fn navigator(&self) -> Navigator[src]

impl Window[src]

pub fn external(&self) -> Result<External, JsValue>[src]

impl Window[src]

pub fn onappinstalled(&self) -> Option<Function>[src]

impl Window[src]

pub fn set_onappinstalled(&self, value: Option<&Function>)[src]

impl Window[src]

pub fn screen(&self) -> Result<Screen, JsValue>[src]

impl Window[src]

pub fn inner_width(&self) -> Result<JsValue, JsValue>[src]

impl Window[src]

pub fn set_inner_width(&self, value: &JsValue) -> Result<(), JsValue>[src]

impl Window[src]

pub fn inner_height(&self) -> Result<JsValue, JsValue>[src]

impl Window[src]

pub fn set_inner_height(&self, value: &JsValue) -> Result<(), JsValue>[src]

impl Window[src]

pub fn scroll_x(&self) -> Result<f64, JsValue>[src]

impl Window[src]

pub fn page_x_offset(&self) -> Result<f64, JsValue>[src]

impl Window[src]

pub fn scroll_y(&self) -> Result<f64, JsValue>[src]

impl Window[src]

pub fn page_y_offset(&self) -> Result<f64, JsValue>[src]

impl Window[src]

pub fn screen_x(&self) -> Result<JsValue, JsValue>[src]

Struct web_sys::Window[−][src]

`impl Window`[src]

`pub fn window(&self) -> Window`[src]

`impl Window`[src]

`pub fn self_(&self) -> Window`[src]

`impl Window`[src]

`pub fn document(&self) -> Option<Document>`[src]

`impl Window`[src]

`pub fn name(&self) -> Result<String, JsValue>`[src]

`impl Window`[src]

`pub fn set_name(&self, value: &str) -> Result<(), JsValue>`[src]

`impl Window`[src]

`pub fn location(&self) -> Location`[src]

`impl Window`[src]

`pub fn history(&self) -> Result<History, JsValue>`[src]

`impl Window`[src]

`pub fn custom_elements(&self) -> CustomElementRegistry`[src]

`impl Window`[src]

`pub fn locationbar(&self) -> Result<BarProp, JsValue>`[src]

`impl Window`[src]

`pub fn menubar(&self) -> Result<BarProp, JsValue>`[src]

`impl Window`[src]

`pub fn personalbar(&self) -> Result<BarProp, JsValue>`[src]

`impl Window`[src]

`pub fn scrollbars(&self) -> Result<BarProp, JsValue>`[src]

`impl Window`[src]

`pub fn statusbar(&self) -> Result<BarProp, JsValue>`[src]

`impl Window`[src]

`pub fn toolbar(&self) -> Result<BarProp, JsValue>`[src]

`impl Window`[src]

`pub fn status(&self) -> Result<String, JsValue>`[src]

`impl Window`[src]

`pub fn set_status(&self, value: &str) -> Result<(), JsValue>`[src]

`impl Window`[src]

`pub fn closed(&self) -> Result<bool, JsValue>`[src]

`impl Window`[src]

`pub fn event(&self) -> JsValue`[src]

`impl Window`[src]

`pub fn frames(&self) -> Result<Window, JsValue>`[src]

`impl Window`[src]

`pub fn length(&self) -> u32`[src]

`impl Window`[src]

`pub fn top(&self) -> Result<Option<Window>, JsValue>`[src]

`impl Window`[src]

`pub fn opener(&self) -> Result<JsValue, JsValue>`[src]

`impl Window`[src]

`pub fn set_opener(&self, value: &JsValue) -> Result<(), JsValue>`[src]

`impl Window`[src]

`pub fn parent(&self) -> Result<Option<Window>, JsValue>`[src]

`impl Window`[src]

`pub fn frame_element(&self) -> Result<Option<Element>, JsValue>`[src]

`impl Window`[src]

`pub fn navigator(&self) -> Navigator`[src]

`impl Window`[src]

`pub fn external(&self) -> Result<External, JsValue>`[src]

`impl Window`[src]

`pub fn onappinstalled(&self) -> Option<Function>`[src]

`impl Window`[src]

`pub fn set_onappinstalled(&self, value: Option<&Function>)`[src]

`impl Window`[src]

`pub fn screen(&self) -> Result<Screen, JsValue>`[src]

`impl Window`[src]

`pub fn inner_width(&self) -> Result<JsValue, JsValue>`[src]

`impl Window`[src]

`pub fn set_inner_width(&self, value: &JsValue) -> Result<(), JsValue>`[src]

`impl Window`[src]

`pub fn inner_height(&self) -> Result<JsValue, JsValue>`[src]

`impl Window`[src]

`pub fn set_inner_height(&self, value: &JsValue) -> Result<(), JsValue>`[src]

`impl Window`[src]

`pub fn scroll_x(&self) -> Result<f64, JsValue>`[src]

`impl Window`[src]

`pub fn page_x_offset(&self) -> Result<f64, JsValue>`[src]

`impl Window`[src]

`pub fn scroll_y(&self) -> Result<f64, JsValue>`[src]

`impl Window`[src]

`pub fn page_y_offset(&self) -> Result<f64, JsValue>`[src]

`impl Window`[src]

`pub fn screen_x(&self) -> Result<JsValue, JsValue>`[src]

`impl Window`[src]