Struct stdweb::web::event::SocketCloseEvent
[−]
[src]
pub struct SocketCloseEvent(_);
A SocketCloseEvent is sent to clients using WebSockets when the connection is closed.
Methods
impl SocketCloseEvent
[src]
fn code(&self) -> SocketCloseCode
[src]
Returns the close code sent by the server.
fn reason(&self) -> String
[src]
Returns the reason the server closed the connection. This is specific to the particular server and sub-protocol.
fn was_clean(&self) -> bool
[src]
Returns whether or not the connection was cleanly closed.
Trait Implementations
impl Clone for SocketCloseEvent
[src]
fn clone(&self) -> SocketCloseEvent
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for SocketCloseEvent
[src]
impl PartialEq for SocketCloseEvent
[src]
fn eq(&self, __arg_0: &SocketCloseEvent) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &SocketCloseEvent) -> bool
[src]
This method tests for !=
.
impl Eq for SocketCloseEvent
[src]
impl TryFrom<Event> for SocketCloseEvent
[src]
type Error = ConversionError
The type returned in the event of a conversion error.
fn try_from(value: Event) -> Result<Self, Self::Error>
[src]
Performs the conversion.
impl InstanceOf for SocketCloseEvent
[src]
fn instance_of(reference: &Reference) -> bool
[src]
Checks whenever a given Reference if of type Self
.
impl AsRef<Reference> for SocketCloseEvent
[src]
impl ReferenceType for SocketCloseEvent
[src]
unsafe fn from_reference_unchecked(reference: Reference) -> Self
[src]
Converts a given reference into a concrete reference-like wrapper. Doesn't do any type checking; highly unsafe to use! Read more
impl TryFrom<Reference> for SocketCloseEvent
[src]
type Error = ConversionError
The type returned in the event of a conversion error.
fn try_from(reference: Reference) -> Result<Self, Self::Error>
[src]
Performs the conversion.
impl<'_r> TryFrom<&'_r Reference> for SocketCloseEvent
[src]
type Error = ConversionError
The type returned in the event of a conversion error.
fn try_from(reference: &Reference) -> Result<Self, Self::Error>
[src]
Performs the conversion.
impl TryFrom<Value> for SocketCloseEvent
[src]
type Error = ConversionError
The type returned in the event of a conversion error.
fn try_from(value: Value) -> Result<Self, Self::Error>
[src]
Performs the conversion.
impl<'_r> TryFrom<&'_r Value> for SocketCloseEvent
[src]
type Error = ConversionError
The type returned in the event of a conversion error.
fn try_from(value: &Value) -> Result<Self, Self::Error>
[src]
Performs the conversion.
impl JsSerialize for SocketCloseEvent
[src]
impl IEvent for SocketCloseEvent
[src]
fn bubbles(&self) -> bool
[src]
Indicates whether this event bubbles upward through the DOM. Read more
fn cancel_bubble(&self) -> bool
[src]
A historical alias to Event.stopPropagation()
. Read more
fn set_cancel_bubble(&self, value: bool)
[src]
A historical alias to Event.stopPropagation()
. Setting this to true
before returning from an event handler will stop propagation of the event. Read more
fn cancelable(&self) -> bool
[src]
Indicates whether the event is cancelable. Read more
fn current_target(&self) -> Option<EventTarget>
[src]
A reference to the currently registered target of this event. Read more
fn default_prevented(&self) -> bool
[src]
Indicates whether preventDefault
has been called on this event. Read more
fn event_phase(&self) -> EventPhase
[src]
Indicates which phase of event flow is currently being evaluated. Read more
fn stop_immediate_propagation(&self)
[src]
Prevents any further listeners from being called for this event. Read more
fn stop_propagation(&self)
[src]
Stops the propagation of this event to descendants in the DOM. Read more
fn target(&self) -> Option<EventTarget>
[src]
Returns a reference to the target to which this event was originally registered. Read more
fn time_stamp(&self) -> Option<f64>
[src]
Returns the time in milliseconds at which this event was created. Read more
fn is_trusted(&self) -> bool
[src]
Indicates whether the event was generated by a user action.
fn event_type(&self) -> String
[src]
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. Read more
fn prevent_default(&self)
[src]
Cancels the event if it is cancelable, without stopping further propagation of the event. Read more
impl ConcreteEvent for SocketCloseEvent
[src]
const EVENT_TYPE: &'static str
EVENT_TYPE: &'static str = "close"
A string representing the event type. Read more