Struct web_sys::History

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

The History object

MDN Documentation

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

Methods

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

impl History

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

The length getter

MDN Documentation

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

impl History

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

The scrollRestoration getter

MDN Documentation

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

impl History

pub fn set_scroll_restoration(
    &self,
    scroll_restoration: ScrollRestoration
) -> Result<(), JsValue>

The scrollRestoration setter

MDN Documentation

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

impl History

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

The state getter

MDN Documentation

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

Trait Implementations

impl From<JsValue> for History

fn from(obj: JsValue) -> History

Performs the conversion.

impl From<History> for JsValue

fn from(obj: History) -> JsValue

Performs the conversion.

impl From<History> for Object

fn from(obj: History) -> Object

Performs the conversion.

impl AsRef<JsValue> for History

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<Object> for History

fn as_ref(&self) -> &Object

Performs the conversion.

impl Clone for History

fn clone(&self) -> History

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for History

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

Formats the value using the given formatter.

impl Deref for History

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl JsCast for History

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 is_instance_of<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value is an instance of the 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.

impl WasmDescribe for History

fn describe()

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.

unsafe fn from_abi(js: Self::Abi, extra: &mut dyn Stack) -> Self

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.

fn into_abi(self, extra: &mut dyn Stack) -> Self::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.

fn into_abi(self, extra: &mut dyn Stack) -> Self::Abi

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

impl OptionFromWasmAbi for History

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 OptionIntoWasmAbi for History

fn none() -> Self::Abi

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

impl<'a> OptionIntoWasmAbi for &'a History

fn none() -> Self::Abi

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

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.

unsafe fn ref_from_abi(js: Self::Abi, extra: &mut dyn Stack) -> Self::Anchor

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