Struct WebSocket 

pub struct WebSocket { /* private fields */ }

The WebSocket class.

MDN Documentation

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

Implementations

impl WebSocket

pub fn url(&self) -> String

impl WebSocket

pub fn ready_state(&self) -> u16

impl WebSocket

pub fn buffered_amount(&self) -> u32

impl WebSocket

pub fn onopen(&self) -> Option<Function>

impl WebSocket

pub fn set_onopen(&self, value: Option<&Function>)

impl WebSocket

pub fn onerror(&self) -> Option<Function>

impl WebSocket

pub fn set_onerror(&self, value: Option<&Function>)

impl WebSocket

pub fn onclose(&self) -> Option<Function>

impl WebSocket

pub fn set_onclose(&self, value: Option<&Function>)

impl WebSocket

pub fn extensions(&self) -> String

impl WebSocket

pub fn protocol(&self) -> String

impl WebSocket

pub fn onmessage(&self) -> Option<Function>

impl WebSocket

pub fn set_onmessage(&self, value: Option<&Function>)

impl WebSocket

pub fn binary_type(&self) -> BinaryType

impl WebSocket

pub fn set_binary_type(&self, value: BinaryType)

impl WebSocket

pub fn new(url: &str) -> Result<WebSocket, JsValue>

impl WebSocket

pub fn new_with_str(url: &str, protocols: &str) -> Result<WebSocket, JsValue>

impl WebSocket

pub fn new_with_str_sequence( url: &str, protocols: &JsValue, ) -> Result<WebSocket, JsValue>

impl WebSocket

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

impl WebSocket

pub fn close_with_code(&self, code: u16) -> Result<(), JsValue>

impl WebSocket

pub fn close_with_code_and_reason( &self, code: u16, reason: &str, ) -> Result<(), JsValue>

impl WebSocket

pub fn send_with_str(&self, data: &str) -> Result<(), JsValue>

impl WebSocket

pub fn send_with_blob(&self, data: &Blob) -> Result<(), JsValue>

impl WebSocket

pub fn send_with_array_buffer(&self, data: &ArrayBuffer) -> Result<(), JsValue>

impl WebSocket

pub fn send_with_array_buffer_view(&self, data: &Object) -> Result<(), JsValue>

impl WebSocket

pub fn send_with_u8_array(&self, data: &[u8]) -> Result<(), JsValue>

impl WebSocket

pub fn send_with_js_u8_array(&self, data: &Uint8Array) -> Result<(), JsValue>

impl WebSocket

pub const CONNECTING: u16

The WebSocket.CONNECTING const.

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

pub const OPEN: u16

The WebSocket.OPEN const.

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

pub const CLOSING: u16

The WebSocket.CLOSING const.

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

pub const CLOSED: u16

The WebSocket.CLOSED const.

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

Methods from Deref<Target = EventTarget>

pub fn add_event_listener_with_callback( &self, type_: &str, listener: &Function, ) -> Result<(), JsValue>

pub fn add_event_listener_with_event_listener( &self, type_: &str, listener: &EventListener, ) -> Result<(), JsValue>

pub fn add_event_listener_with_callback_and_add_event_listener_options( &self, type_: &str, listener: &Function, options: &AddEventListenerOptions, ) -> Result<(), JsValue>

pub fn add_event_listener_with_event_listener_and_add_event_listener_options( &self, type_: &str, listener: &EventListener, options: &AddEventListenerOptions, ) -> Result<(), JsValue>

pub fn add_event_listener_with_callback_and_bool( &self, type_: &str, listener: &Function, options: bool, ) -> Result<(), JsValue>

pub fn add_event_listener_with_event_listener_and_bool( &self, type_: &str, listener: &EventListener, options: bool, ) -> Result<(), JsValue>

pub fn add_event_listener_with_callback_and_add_event_listener_options_and_wants_untrusted( &self, type_: &str, listener: &Function, options: &AddEventListenerOptions, wants_untrusted: Option<bool>, ) -> Result<(), JsValue>

pub fn add_event_listener_with_event_listener_and_add_event_listener_options_and_wants_untrusted( &self, type_: &str, listener: &EventListener, options: &AddEventListenerOptions, wants_untrusted: Option<bool>, ) -> Result<(), JsValue>

pub fn add_event_listener_with_callback_and_bool_and_wants_untrusted( &self, type_: &str, listener: &Function, options: bool, wants_untrusted: Option<bool>, ) -> Result<(), JsValue>

pub fn add_event_listener_with_event_listener_and_bool_and_wants_untrusted( &self, type_: &str, listener: &EventListener, options: bool, wants_untrusted: Option<bool>, ) -> Result<(), JsValue>

pub fn dispatch_event(&self, event: &Event) -> Result<bool, JsValue>

pub fn remove_event_listener_with_callback( &self, type_: &str, listener: &Function, ) -> Result<(), JsValue>

pub fn remove_event_listener_with_event_listener( &self, type_: &str, listener: &EventListener, ) -> Result<(), JsValue>

pub fn remove_event_listener_with_callback_and_event_listener_options( &self, type_: &str, listener: &Function, options: &EventListenerOptions, ) -> Result<(), JsValue>

pub fn remove_event_listener_with_event_listener_and_event_listener_options( &self, type_: &str, listener: &EventListener, options: &EventListenerOptions, ) -> Result<(), JsValue>

pub fn remove_event_listener_with_callback_and_bool( &self, type_: &str, listener: &Function, options: bool, ) -> Result<(), JsValue>

pub fn remove_event_listener_with_event_listener_and_bool( &self, type_: &str, listener: &EventListener, options: bool, ) -> Result<(), JsValue>

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

pub fn has_own_property(&self, property: &JsValue) -> bool

👎Deprecated:

Use Object::hasOwn instead.

pub fn is_prototype_of(&self, value: &JsValue) -> bool

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

pub fn to_locale_string(&self) -> JsString

pub fn to_string(&self) -> JsString

pub fn to_js_string(&self) -> JsString

pub fn value_of(&self) -> Object

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn unchecked_into_f64(&self) -> f64

Returns the value as f64 without type checking. Used by serde-wasm-bindgen for numeric conversions.

pub fn has_type<T>(&self) -> bool

where T: JsCast,

Check if this value is an instance of a specific JS type.

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Checked division.

pub fn pow(&self, rhs: &JsValue) -> JsValue

Power operation.

pub fn bit_and(&self, rhs: &JsValue) -> JsValue

Bitwise AND.

pub fn bit_or(&self, rhs: &JsValue) -> JsValue

Bitwise OR.

pub fn bit_xor(&self, rhs: &JsValue) -> JsValue

Bitwise XOR.

pub fn bit_not(&self) -> JsValue

Bitwise NOT.

pub fn shl(&self, rhs: &JsValue) -> JsValue

Left shift.

pub fn shr(&self, rhs: &JsValue) -> JsValue

Signed right shift.

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Unsigned right shift.

pub fn add(&self, rhs: &JsValue) -> JsValue

Add.

pub fn sub(&self, rhs: &JsValue) -> JsValue

Subtract.

pub fn mul(&self, rhs: &JsValue) -> JsValue

Multiply.

pub fn div(&self, rhs: &JsValue) -> JsValue

Divide.

pub fn rem(&self, rhs: &JsValue) -> JsValue

Remainder.

pub fn neg(&self) -> JsValue

Negate.

pub fn lt(&self, other: &JsValue) -> bool

Less than comparison.

pub fn le(&self, other: &JsValue) -> bool

Less than or equal comparison.

pub fn gt(&self, other: &JsValue) -> bool

Greater than comparison.

pub fn ge(&self, other: &JsValue) -> bool

Greater than or equal comparison.

pub fn loose_eq(&self, other: &JsValue) -> bool

Loose equality (==).

pub fn is_falsy(&self) -> bool

Check if this value is a falsy value in JavaScript.

pub fn is_truthy(&self) -> bool

Check if this value is a truthy value in JavaScript.

pub fn is_object(&self) -> bool

Check if this value is an object.

pub fn is_function(&self) -> bool

Check if this value is a function.

pub fn is_string(&self) -> bool

Check if this value is a string.

pub fn is_symbol(&self) -> bool

Check if this value is a symbol.

pub fn is_bigint(&self) -> bool

Check if this value is a bigint.

pub fn is_array(&self) -> bool

Check if this value is an Array.

pub fn is_undefined(&self) -> bool

Check if this value is undefined.

pub fn is_null(&self) -> bool

Check if this value is null.

pub fn is_null_or_undefined(&self) -> bool

Check if this value is null or undefined.

pub fn js_typeof(&self) -> JsValue

Get the typeof this value as a string.

pub fn js_in(&self, obj: &JsValue) -> bool

Check if this value has a property with the given name.

pub fn as_bool(&self) -> Option<bool>

Get the value as a bool.

pub fn as_f64(&self) -> Option<f64>

Get the value as an f64.

pub fn as_string(&self) -> Option<String>

Get the value as a string.

pub fn as_debug_string(&self) -> String

Get a debug string representation of the value.

Trait Implementations

impl AsRef<EventTarget> for WebSocket

fn as_ref(&self) -> &EventTarget

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

impl AsRef<JsValue> for WebSocket

fn as_ref(&self) -> &JsValue

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

impl AsRef<Object> for WebSocket

fn as_ref(&self) -> &Object

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

impl AsRef<WebSocket> for WebSocket

fn as_ref(&self) -> &WebSocket

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

impl BatchableResult for WebSocket

fn try_placeholder(batch: &mut Runtime<'_>) -> Option<Self>

impl BinaryDecode for WebSocket

fn decode(decoder: &mut DecodedData<'_>) -> Result<Self, DecodeError>

impl BinaryEncode for WebSocket

fn encode(self, encoder: &mut EncodedData)

impl Clone for WebSocket

fn clone(&self) -> WebSocket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocket

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

Formats the value using the given formatter.

impl Deref for WebSocket

type Target = EventTarget

The resulting type after dereferencing.

fn deref(&self) -> &EventTarget

Dereferences the value.

impl EncodeTypeDef for WebSocket

fn encode_type_def(type_def: &mut TypeDef)

impl Eq for WebSocket

impl ErasableGeneric for WebSocket

type Repr = JsValue

impl From<JsValue> for WebSocket

fn from(val: JsValue) -> Self

Converts to this type from the input type.

impl From<WebSocket> for JsValue

fn from(val: WebSocket) -> Self

Converts to this type from the input type.

impl From<WebSocket> for EventTarget

fn from(val: WebSocket) -> EventTarget

Converts to this type from the input type.

impl From<WebSocket> for Object

fn from(val: WebSocket) -> Object

Converts to this type from the input type.

impl IntoJsGeneric for WebSocket

where WebSocket: JsGeneric,

type JsCanon = WebSocket

fn to_js(self) -> Self::JsCanon

impl JsCast for WebSocket

fn instanceof(__val: &JsValue) -> bool

Check if a JsValue is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Unchecked cast from JsValue to this type.

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Unchecked cast from a JsValue reference to a reference of this type.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic type check to see whether the JsValue provided is a value of this type.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Try to cast this value to type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Try to get a reference to type T from this value.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Unchecked cast to another type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Unchecked cast to a reference of another type.

impl JsRefEncode for WebSocket

fn js_ref(&self) -> JsRef

impl PartialEq for WebSocket

fn eq(&self, other: &WebSocket) -> 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 Promising for WebSocket

type Resolution = WebSocket

impl StructuralPartialEq for WebSocket

impl UpcastFrom<WebSocket> for JsValue

impl UpcastFrom<WebSocket> for JsOption<JsValue>

impl UpcastFrom<WebSocket> for WebSocket

impl UpcastFrom<WebSocket> for JsOption<WebSocket>

impl UpcastFrom<WebSocket> for EventTarget

impl UpcastFrom<WebSocket> for JsOption<EventTarget>

impl UpcastFrom<WebSocket> for Object

impl UpcastFrom<WebSocket> for JsOption<Object>