Struct web_sys::WebSocket

#[repr(transparent)]
pub struct WebSocket { /* fields omitted */ }

The WebSocket object

MDN Documentation

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

Methods

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: &mut [u8]) -> Result<(), JsValue>

The send() method

MDN Documentation

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

impl WebSocket

pub fn url(&self) -> String

The url getter

MDN Documentation

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

impl WebSocket

pub fn ready_state(&self) -> u16

The readyState getter

MDN Documentation

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

impl WebSocket

pub fn buffered_amount(&self) -> u32

The bufferedAmount getter

MDN Documentation

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

impl WebSocket

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

The onopen getter

MDN Documentation

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

impl WebSocket

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

The onopen setter

MDN Documentation

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

impl WebSocket

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

The onerror getter

MDN Documentation

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

impl WebSocket

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

The onerror setter

MDN Documentation

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

impl WebSocket

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

The onclose getter

MDN Documentation

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

impl WebSocket

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

The onclose setter

MDN Documentation

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

impl WebSocket

pub fn extensions(&self) -> String

The extensions getter

MDN Documentation

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

impl WebSocket

pub fn protocol(&self) -> String

The protocol getter

MDN Documentation

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

impl WebSocket

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

The onmessage getter

MDN Documentation

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

impl WebSocket

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

The onmessage setter

MDN Documentation

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

impl WebSocket

pub fn binary_type(&self) -> BinaryType

The binaryType getter

MDN Documentation

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

impl WebSocket

pub fn set_binary_type(&self, binary_type: BinaryType)

The binaryType setter

MDN Documentation

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

impl WebSocket

pub const CONNECTING: u16

impl WebSocket

pub const OPEN: u16

impl WebSocket

pub const CLOSING: u16

impl WebSocket

pub const CLOSED: u16

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_event_listener(
    &self,
    type_: &str,
    listener: &EventListener
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

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

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

The addEventListener() method

MDN Documentation

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

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

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventListener, 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_event_listener_and_bool(
    &self,
    type_: &str,
    listener: &EventListener,
    options: bool
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

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

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>

The addEventListener() method

MDN Documentation

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

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>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: AddEventListenerOptions, EventListener, 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 add_event_listener_with_event_listener_and_bool_and_wants_untrusted(
    &self,
    type_: &str,
    listener: &EventListener,
    options: bool,
    wants_untrusted: Option<bool>
) -> Result<(), JsValue>

The addEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, 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_event_listener(
    &self,
    type_: &str,
    listener: &EventListener
) -> Result<(), JsValue>

The removeEventListener() method

MDN Documentation

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

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

The removeEventListener() method

MDN Documentation

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

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

The removeEventListener() method

MDN Documentation

This API requires the following crate features to be activated: EventListener, EventListenerOptions, 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

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

The removeEventListener() method

MDN Documentation

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

Trait Implementations

impl From<JsValue> for WebSocket

fn from(obj: JsValue) -> WebSocket

Performs the conversion.

impl From<WebSocket> for JsValue

fn from(obj: WebSocket) -> JsValue

Performs the conversion.

impl From<WebSocket> for EventTarget

fn from(obj: WebSocket) -> EventTarget

Performs the conversion.

impl From<WebSocket> for Object

fn from(obj: WebSocket) -> Object

Performs the conversion.

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 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: &WebSocket) -> bool

This method tests for !=.

impl Eq for WebSocket

impl AsRef<JsValue> for WebSocket

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<WebSocket> for WebSocket

fn as_ref(&self) -> &WebSocket

Performs the conversion.

impl AsRef<EventTarget> for WebSocket

fn as_ref(&self) -> &EventTarget

Performs the conversion.

impl AsRef<Object> for WebSocket

fn as_ref(&self) -> &Object

Performs the conversion.

impl Deref for WebSocket

type Target = EventTarget

The resulting type after dereferencing.

fn deref(&self) -> &EventTarget

Dereferences the value.

impl Debug for WebSocket

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

Formats the value using the given formatter.

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) -> bool where
    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) -> T where
    T: JsCast, 

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

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

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

fn is_instance_of<T>(&self) -> bool where
    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 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 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<'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 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 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 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<'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.