Struct SocketCloseEvent

pub struct SocketCloseEvent(/* private fields */);

A SocketCloseEvent is sent to clients using WebSockets when the connection is closed.

(JavaScript docs)

Implementations

impl SocketCloseEvent

pub fn code(&self) -> SocketCloseCode

Returns the close code sent by the server.

(JavaScript docs)

pub fn reason(&self) -> String

Returns the reason the server closed the connection. This is specific to the particular server and sub-protocol.

(JavaScript docs)

pub fn was_clean(&self) -> bool

Returns whether or not the connection was cleanly closed.

(JavaScript docs)

Trait Implementations

impl AsRef<Reference> for SocketCloseEvent

fn as_ref(&self) -> &Reference

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SocketCloseEvent

fn clone(&self) -> SocketCloseEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConcreteEvent for SocketCloseEvent

const EVENT_TYPE: &'static str = "close"

A string representing the event type.

impl Debug for SocketCloseEvent

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

Formats the value using the given formatter.

impl From<SocketCloseEvent> for Reference

fn from(value: SocketCloseEvent) -> Self

Converts to this type from the input type.

impl IEvent for SocketCloseEvent

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 InstanceOf for SocketCloseEvent

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.

impl PartialEq for SocketCloseEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ReferenceType for SocketCloseEvent

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<'_r> TryFrom<&'_r Reference> for SocketCloseEvent

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 Value> for SocketCloseEvent

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 TryFrom<Reference> for SocketCloseEvent

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<SocketCloseEvent> for Reference

type Error = Void

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Value> for SocketCloseEvent

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 Eq for SocketCloseEvent

impl JsSerialize for SocketCloseEvent

impl StructuralPartialEq for SocketCloseEvent