Struct yew_hooks::UseWebSocketHandle

source · [−]

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 */
}

Expand description

State handle for the use_web_socket 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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl !RefUnwindSafe for UseWebSocketHandle

impl !Send for UseWebSocketHandle

impl !Sync for UseWebSocketHandle

impl Unpin for UseWebSocketHandle

impl !UnwindSafe for UseWebSocketHandle

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoPropValue<Option<T>> for T

pub fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.

impl<T> IntoPropValue<T> for T

pub fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.