Struct yew_hooks::prelude::UseWebSocketHandle

pub struct UseWebSocketHandle {
    pub ready_state: UseStateHandle<UseWebSocketReadyState>,
    pub message: UseStatePtrEqHandle<Option<String>>,
    pub message_bytes: UseStatePtrEqHandle<Option<Vec<u8>>>,
    pub ws: Rc<RefCell<Option<WebSocket>>>,
    /* private fields */
}

State handle for the use_websocket hook.

Fields

ready_state: UseStateHandle<UseWebSocketReadyState>

The current state of the WebSocket connection.

message: UseStatePtrEqHandle<Option<String>>

Latest text message received from WebSocket.

message_bytes: UseStatePtrEqHandle<Option<Vec<u8>>>

Latest binary message received from WebSocket.

ws: Rc<RefCell<Option<WebSocket>>>

The WebSocket instance.

Implementations

impl UseWebSocketHandle

pub fn open(&self)

Connect WebSocket manually. If already connected, close the current one and reconnect.

pub fn close(&self)

Disconnect WebSocket manually.

pub fn send(&self, data: String)

Send text message to WebSocket.

pub fn send_bytes(&self, data: Vec<u8>)

Send binary message to WebSocket.

Trait Implementations

impl Clone for UseWebSocketHandle

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.