Struct web_sys::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

Getter for the url field of this object.

MDN Documentation

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

impl WebSocket

pub fn ready_state(&self) -> u16

Getter for the readyState field of this object.

MDN Documentation

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

impl WebSocket

pub fn buffered_amount(&self) -> u32

Getter for the bufferedAmount field of this object.

MDN Documentation

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

impl WebSocket

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

Getter for the onopen field of this object.

MDN Documentation

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

impl WebSocket

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

Setter for the onopen field of this object.

MDN Documentation

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

impl WebSocket

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

Getter for the onerror field of this object.

MDN Documentation

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

impl WebSocket

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

Setter for the onerror field of this object.

MDN Documentation

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

impl WebSocket

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

Getter for the onclose field of this object.

MDN Documentation

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

impl WebSocket

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

Setter for the onclose field of this object.

MDN Documentation

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

impl WebSocket

pub fn extensions(&self) -> String

Getter for the extensions field of this object.

MDN Documentation

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

impl WebSocket

pub fn protocol(&self) -> String

Getter for the protocol field of this object.

MDN Documentation

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

impl WebSocket

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

Getter for the onmessage field of this object.

MDN Documentation

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

impl WebSocket

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

Setter for the onmessage field of this object.

MDN Documentation

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

impl WebSocket

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

The new WebSocket(..) constructor, creating a new instance of WebSocket.

MDN Documentation

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

impl WebSocket

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

The new WebSocket(..) constructor, creating a new instance of WebSocket.

MDN Documentation

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

impl WebSocket

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

The new WebSocket(..) constructor, creating a new instance of WebSocket.

MDN Documentation

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

impl WebSocket

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

The close() method.

MDN Documentation

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

impl WebSocket

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

The close() method.

MDN Documentation

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

impl WebSocket

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

The close() method.

MDN Documentation

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

impl WebSocket

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

The send() method.

MDN Documentation

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

impl WebSocket

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

The send() method.

MDN Documentation

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

impl WebSocket

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

The send() method.

MDN Documentation

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

impl WebSocket

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

The send() method.

MDN Documentation

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

impl WebSocket

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

The send() method.

MDN Documentation

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

impl WebSocket

pub const CONNECTING: u16 = 0u16

The WebSocket.CONNECTING const.

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

pub const OPEN: u16 = 1u16

The WebSocket.OPEN const.

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

pub const CLOSING: u16 = 2u16

The WebSocket.CLOSING const.

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

pub const CLOSED: u16 = 3u16

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>

The addEventListener() method.

MDN Documentation

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

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

The addEventListener() method.

MDN Documentation

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

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>

The addEventListener() method.

MDN Documentation

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

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

The dispatchEvent() method.

MDN Documentation

This API requires the following crate features to be activated: Event, EventTarget

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

The removeEventListener() method.

MDN Documentation

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

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

The removeEventListener() method.

MDN Documentation

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

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

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

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

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

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

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

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue = _

pub const UNDEFINED: JsValue = _

pub const TRUE: JsValue = _

pub const FALSE: JsValue = _

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

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

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

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

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

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

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

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

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

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

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

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

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

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

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

Applies the binary ** JS operator on the two JsValues.

MDN documentation

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

Applies the binary < JS operator on the two JsValues.

MDN documentation

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

Applies the binary <= JS operator on the two JsValues.

MDN documentation

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

Applies the binary >= JS operator on the two JsValues.

MDN documentation

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

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

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 Clone for WebSocket

fn clone(&self) -> WebSocket

Returns a copy 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 From<JsValue> for WebSocket

fn from(obj: JsValue) -> WebSocket

Converts to this type from the input type.

impl From<WebSocket> for EventTarget

fn from(obj: WebSocket) -> EventTarget

Converts to this type from the input type.

impl From<WebSocket> for JsValue

fn from(obj: WebSocket) -> JsValue

Converts to this type from the input type.

impl From<WebSocket> for Object

fn from(obj: WebSocket) -> Object

Converts to this type from the input type.

impl FromWasmAbi for WebSocket

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a WebSocket

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for WebSocket

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for WebSocket

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

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

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> boolwhere T: JsCast,

Test whether this JS value has a type T.

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

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> Twhere T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &Twhere T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> boolwhere T: JsCast,

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

fn is_type_of(val: &JsValue) -> bool

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

impl LongRefFromWasmAbi for WebSocket

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = WebSocket

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for WebSocket

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a WebSocket

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for WebSocket

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl PartialEq<WebSocket> for WebSocket

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

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

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

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

impl RefFromWasmAbi for WebSocket

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<WebSocket>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for WebSocket

fn describe()

impl Eq for WebSocket

impl StructuralEq for WebSocket

impl StructuralPartialEq for WebSocket