Struct stdweb::web::event::PopStateEvent

pub struct PopStateEvent(_);

A PopStateEvent is dispatched to the window every time the active history entry changes between two history entries for the same document. If the history entry being activated was created by a call to history.push_state() or was affected by a call to history.replace_state(), the PopStateEvent's state property contains a copy of the history entry's state object.

Note that just calling history.push_state() or history.replace_state() won't trigger a PopStateEvent. The PopStateEvent is only triggered by doing a browser action such as a clicking on the back button (or calling history.back()). And the event is only triggered when the user navigates between two history entries for the same document.

Browsers tend to handle the PopStateEvent differently on page load. Chrome and Safari always emit a PopStateEvent on page load, but Firefox doesn't.

(Javascript docs)

Methods

impl PopStateEvent

pub fn state(&self) -> Value

The state object associated to the new history entry, if that entry was created with push_state or affected by replace_state.

Example usage:

let state: Option<MyStruct> = event.state().try_into().ok();

Trait Implementations

impl JsSerialize for PopStateEvent

impl TryFrom<PopStateEvent> for Reference

type Error = Void

The type returned in the event of a conversion error.

fn try_from(value: PopStateEvent) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Reference> for PopStateEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Reference> for PopStateEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: &Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for PopStateEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Value> for PopStateEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl InstanceOf for PopStateEvent

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.

impl ReferenceType for PopStateEvent

unsafe fn from_reference_unchecked(reference: Reference) -> Self

Converts a given reference into a concrete reference-like wrapper. Doesn't do any type checking; highly unsafe to use!

impl IEvent for PopStateEvent

fn bubbles(&self) -> bool

Indicates whether this event bubbles upward through the DOM.

fn cancel_bubble(&self) -> bool

A historical alias to Event.stopPropagation().

fn set_cancel_bubble(&self, value: bool)

A historical alias to Event.stopPropagation(). Setting this to true before returning from an event handler will stop propagation of the event.

fn cancelable(&self) -> bool

Indicates whether the event is cancelable.

fn current_target(&self) -> Option<EventTarget>

A reference to the currently registered target of this event.

fn default_prevented(&self) -> bool

Indicates whether preventDefault has been called on this event.

fn event_phase(&self) -> EventPhase

Indicates which phase of event flow is currently being evaluated.

fn stop_immediate_propagation(&self)

Prevents any further listeners from being called for this event.

fn stop_propagation(&self)

Stops the propagation of this event to descendants in the DOM.

fn target(&self) -> Option<EventTarget>

Returns a reference to the target to which this event was originally registered.

fn time_stamp(&self) -> Option<f64>

Returns the time in milliseconds at which this event was created.

fn is_trusted(&self) -> bool

Indicates whether the event was generated by a user action.

fn event_type(&self) -> String

Returns a string containing the type of event. It is set when the event is constructed and is the name commonly used to refer to the specific event.

fn prevent_default(&self)

Cancels the event if it is cancelable, without stopping further propagation of the event.

impl ConcreteEvent for PopStateEvent

const EVENT_TYPE: &'static str

A string representing the event type.

impl From<PopStateEvent> for Reference

fn from(value: PopStateEvent) -> Self

Performs the conversion.

impl Eq for PopStateEvent

impl AsRef<Reference> for PopStateEvent

fn as_ref(&self) -> &Reference

Performs the conversion.

impl PartialEq<PopStateEvent> for PopStateEvent

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

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

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

This method tests for !=.

impl Clone for PopStateEvent

fn clone(&self) -> PopStateEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PopStateEvent

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

Formats the value using the given formatter.