[][src]Struct web_sys::WebSocket

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

The WebSocket class.

MDN Documentation

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

Implementations

impl WebSocket[src]

pub fn url(&self) -> String[src]

Getter for the url field of this object.

MDN Documentation

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

impl WebSocket[src]

pub fn ready_state(&self) -> u16[src]

Getter for the readyState field of this object.

MDN Documentation

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

impl WebSocket[src]

pub fn buffered_amount(&self) -> u32[src]

Getter for the bufferedAmount field of this object.

MDN Documentation

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

impl WebSocket[src]

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

Getter for the onopen field of this object.

MDN Documentation

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

impl WebSocket[src]

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

Setter for the onopen field of this object.

MDN Documentation

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

impl WebSocket[src]

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

Getter for the onerror field of this object.

MDN Documentation

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

impl WebSocket[src]

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

Setter for the onerror field of this object.

MDN Documentation

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

impl WebSocket[src]

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

Getter for the onclose field of this object.

MDN Documentation

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

impl WebSocket[src]

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

Setter for the onclose field of this object.

MDN Documentation

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

impl WebSocket[src]

pub fn extensions(&self) -> String[src]

Getter for the extensions field of this object.

MDN Documentation

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

impl WebSocket[src]

pub fn protocol(&self) -> String[src]

Getter for the protocol field of this object.

MDN Documentation

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

impl WebSocket[src]

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

Getter for the onmessage field of this object.

MDN Documentation

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

impl WebSocket[src]

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

Setter for the onmessage field of this object.

MDN Documentation

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

impl WebSocket[src]

pub fn binary_type(&self) -> BinaryType[src]

Getter for the binaryType field of this object.

MDN Documentation

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

impl WebSocket[src]

pub fn set_binary_type(&self, value: BinaryType)[src]

Setter for the binaryType field of this object.

MDN Documentation

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

impl WebSocket[src]

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

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[src]

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

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[src]

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

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[src]

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

The close() method.

MDN Documentation

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

impl WebSocket[src]

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

The close() method.

MDN Documentation

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

impl WebSocket[src]

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

The close() method.

MDN Documentation

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

impl WebSocket[src]

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

The send() method.

MDN Documentation

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

impl WebSocket[src]

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

The send() method.

MDN Documentation

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

impl WebSocket[src]

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

The send() method.

MDN Documentation

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

impl WebSocket[src]

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

The send() method.

MDN Documentation

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

impl WebSocket[src]

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

The send() method.

MDN Documentation

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

impl WebSocket[src]

pub const CONNECTING: u16[src]

The WebSocket.CONNECTING const.

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

pub const OPEN: u16[src]

The WebSocket.OPEN const.

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

pub const CLOSING: u16[src]

The WebSocket.CLOSING const.

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

pub const CLOSED: u16[src]

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>
[src]

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>
[src]

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>
[src]

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>
[src]

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>
[src]

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>
[src]

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>
[src]

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>
[src]

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>
[src]

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>
[src]

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>[src]

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>
[src]

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>
[src]

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>
[src]

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>
[src]

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>
[src]

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>
[src]

The removeEventListener() method.

MDN Documentation

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

Trait Implementations

impl AsRef<EventTarget> for WebSocket[src]

impl AsRef<JsValue> for WebSocket[src]

impl AsRef<Object> for WebSocket[src]

impl AsRef<WebSocket> for WebSocket[src]

impl Clone for WebSocket[src]

impl Debug for WebSocket[src]

impl Deref for WebSocket[src]

type Target = EventTarget

The resulting type after dereferencing.

impl Eq for WebSocket[src]

impl From<JsValue> for WebSocket[src]

impl From<WebSocket> for JsValue[src]

impl From<WebSocket> for EventTarget[src]

impl From<WebSocket> for Object[src]

impl FromWasmAbi for WebSocket[src]

type Abi = <JsValue as FromWasmAbi>::Abi

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

impl IntoWasmAbi for WebSocket[src]

type Abi = <JsValue as IntoWasmAbi>::Abi

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

impl<'a> IntoWasmAbi for &'a WebSocket[src]

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

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

impl JsCast for WebSocket[src]

impl OptionFromWasmAbi for WebSocket[src]

impl OptionIntoWasmAbi for WebSocket[src]

impl<'a> OptionIntoWasmAbi for &'a WebSocket[src]

impl PartialEq<WebSocket> for WebSocket[src]

impl RefFromWasmAbi for WebSocket[src]

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. Read more

impl StructuralEq for WebSocket[src]

impl StructuralPartialEq for WebSocket[src]

impl WasmDescribe for WebSocket[src]

Auto Trait Implementations

impl RefUnwindSafe for WebSocket

impl !Send for WebSocket

impl !Sync for WebSocket

impl Unpin for WebSocket

impl UnwindSafe for WebSocket

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ReturnWasmAbi for T where
    T: IntoWasmAbi
[src]

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.