Struct History

pub struct History { /* private fields */ }

The Web History API.

The History API represents the URL and forward/backward buttons in the browser. It’s modeled as a stack where URLs can be pushed/popped, and a cursor can be moved forward/backward along the stack.

History also implements Stream which returns a url every time the cursor is moved along the stack. The only time this event is not triggered is when the cursor moves because of a new entry being pushed onto the stack.

Implementations

impl History

pub fn new() -> Self

Create a new instance of History.

pub fn len(&self) -> usize

Returns the number of urls in the History stack.

pub fn is_empty(&self) -> bool

Returns true if the History stack contains no items.

pub fn current(&self) -> String

Get the current url from the History stack.

pub fn push(&self, url: &str)

Push a new url onto the history stack.

pub fn pop(&self)

Pop a url from the history stack.

pub fn replace(&self, url: &str)

Replace the url currently on the stack with another url.

pub async fn move_by(&self, delta: i32)

Move the cursor forwards and backwards through the History stack depending on the value of the parameter.

Passing a value of 0 will reload the page.

pub async fn move_next(&self)

Moves the cursor to the next url in the History stack.

pub async fn move_prev(&self)

Moves the cursor to the previous url in the History stack.

pub async fn reload(&self)

Reload the current url, like the Refresh button.

Trait Implementations

impl Debug for History

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

Formats the value using the given formatter.

impl Default for History

fn default() -> Self

Returns the “default value” for a type.

impl Stream for History

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Return URLs generated by moving the cursor on the stack. This is equivalent to listening for the "popstate" event.

type Item = String

Values yielded by the stream.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'pin> Unpin for History

where PinnedFieldsOf<__History<'pin>>: Unpin,