Struct sauron::prelude::web_sys::History

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

The History class.

MDN Documentation

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

Implementations

impl History

pub fn length(&self) -> Result<u32, JsValue>

Getter for the length field of this object.

MDN Documentation

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

impl History

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

Getter for the state field of this object.

MDN Documentation

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

impl History

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

The back() method.

MDN Documentation

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

impl History

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

The forward() method.

MDN Documentation

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

impl History

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

The go() method.

MDN Documentation

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

impl History

pub fn go_with_delta(&self, delta: i32) -> Result<(), JsValue>

The go() method.

MDN Documentation

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

impl History

pub fn push_state(&self, data: &JsValue, title: &str) -> Result<(), JsValue>

The pushState() method.

MDN Documentation

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

impl History

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

The pushState() method.

MDN Documentation

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

impl History

pub fn replace_state(&self, data: &JsValue, title: &str) -> Result<(), JsValue>

The replaceState() method.

MDN Documentation

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

impl History

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

The replaceState() method.

MDN Documentation

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

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 into_serde<T>(&self) -> Result<T, Error> where
    T: for<'a> Deserialize<'a>, 

Invokes JSON.stringify on this value and then parses the resulting JSON into an arbitrary Rust value.

This function will first call JSON.stringify on the JsValue itself. The resulting string is then passed into Rust which then parses it as JSON into the resulting value.

Usage of this API requires activating the serde-serialize feature of the wasm-bindgen crate.

Errors

Returns any error encountered when parsing the JSON into a T.

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_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool

Tests whether the value is "truthy".

pub fn is_falsy(&self) -> bool

Tests whether the value is "falsy".

Trait Implementations

impl AsRef<History> for History

pub fn as_ref(&self) -> &History

Performs the conversion.

impl AsRef<JsValue> for History

pub fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<Object> for History

pub fn as_ref(&self) -> &Object

Performs the conversion.

impl Clone for History

pub fn clone(&self) -> History

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for History

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

Formats the value using the given formatter.

impl Deref for History

type Target = Object

The resulting type after dereferencing.

pub fn deref(&self) -> &Object

Dereferences the value.

impl Eq for History

impl From<History> for JsValue

pub fn from(obj: History) -> JsValue

Performs the conversion.

impl From<History> for Object

pub fn from(obj: History) -> Object

Performs the conversion.

impl From<JsValue> for History

pub fn from(obj: JsValue) -> History

Performs the conversion.

impl FromWasmAbi for History

type Abi = <JsValue as FromWasmAbi>::Abi

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

pub unsafe fn from_abi(js: <History as FromWasmAbi>::Abi) -> History

Recover a Self from Self::Abi.

impl IntoWasmAbi for History

type Abi = <JsValue as IntoWasmAbi>::Abi

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

pub fn into_abi(self) -> <History as IntoWasmAbi>::Abi

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

impl<'a> IntoWasmAbi for &'a History

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

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

pub fn into_abi(self) -> <&'a History as IntoWasmAbi>::Abi

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

impl JsCast for History

pub fn instanceof(val: &JsValue) -> bool

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

pub fn unchecked_from_js(val: JsValue) -> History

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

pub fn unchecked_from_js_ref(val: &JsValue) -> &History

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

pub fn has_type<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value has a type T.

pub 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.

pub 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.

pub fn unchecked_into<T>(self) -> T where
    T: JsCast, 

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

pub fn unchecked_ref<T>(&self) -> &T where
    T: JsCast, 

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

pub fn is_instance_of<T>(&self) -> bool where
    T: JsCast, 

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

pub fn is_type_of(val: &JsValue) -> bool

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

impl OptionFromWasmAbi for History

pub fn is_none(abi: &<History as FromWasmAbi>::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 History

pub fn none() -> <&'a History as IntoWasmAbi>::Abi

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

impl OptionIntoWasmAbi for History

pub fn none() -> <History as IntoWasmAbi>::Abi

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

impl PartialEq<History> for History

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

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

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

This method tests for !=.

impl RefFromWasmAbi for History

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<History>

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.

pub unsafe fn ref_from_abi(
    js: <History as RefFromWasmAbi>::Abi
) -> <History as RefFromWasmAbi>::Anchor

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

impl StructuralEq for History

impl StructuralPartialEq for History