Struct leptos_use::UseWebsocketReturn

source · 
pub struct UseWebsocketReturn<OpenFn, CloseFn, SendFn, SendBytesFn>
where
    OpenFn: Fn() + Clone + 'static,
    CloseFn: Fn() + Clone + 'static,
    SendFn: Fn(&str) + Clone + 'static,
    SendBytesFn: Fn(Vec<u8>) + Clone + 'static,
{
    pub ready_state: Signal<ConnectionReadyState>,
    pub message: Signal<Option<String>>,
    pub message_bytes: Signal<Option<Vec<u8>>>,
    pub ws: Option<WebSocket>,
    pub open: OpenFn,
    pub close: CloseFn,
    pub send: SendFn,
    pub send_bytes: SendBytesFn,
}
Expand description

Return type of use_websocket.

Fields§

§ready_state: Signal<ConnectionReadyState>

The current state of the WebSocket connection.

§message: Signal<Option<String>>

Latest text message received from WebSocket.

§message_bytes: Signal<Option<Vec<u8>>>

Latest binary message received from WebSocket.

§ws: Option<WebSocket>

The WebSocket instance.

§open: OpenFn

Opens the WebSocket connection

§close: CloseFn

Closes the WebSocket connection

§send: SendFn

Sends text (string) based data

§send_bytes: SendBytesFn

Sends binary data

Trait Implementations§

source§

impl<OpenFn, CloseFn, SendFn, SendBytesFn> Clone for UseWebsocketReturn<OpenFn, CloseFn, SendFn, SendBytesFn>
where OpenFn: Fn() + Clone + 'static + Clone, CloseFn: Fn() + Clone + 'static + Clone, SendFn: Fn(&str) + Clone + 'static + Clone, SendBytesFn: Fn(Vec<u8>) + Clone + 'static + Clone,

source§

fn clone(&self) -> UseWebsocketReturn<OpenFn, CloseFn, SendFn, SendBytesFn>

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<OpenFn, CloseFn, SendFn, SendBytesFn> Freeze for UseWebsocketReturn<OpenFn, CloseFn, SendFn, SendBytesFn>
where OpenFn: Freeze, CloseFn: Freeze, SendFn: Freeze, SendBytesFn: Freeze,

§

impl<OpenFn, CloseFn, SendFn, SendBytesFn> !RefUnwindSafe for UseWebsocketReturn<OpenFn, CloseFn, SendFn, SendBytesFn>

§

impl<OpenFn, CloseFn, SendFn, SendBytesFn> !Send for UseWebsocketReturn<OpenFn, CloseFn, SendFn, SendBytesFn>

§

impl<OpenFn, CloseFn, SendFn, SendBytesFn> !Sync for UseWebsocketReturn<OpenFn, CloseFn, SendFn, SendBytesFn>

§

impl<OpenFn, CloseFn, SendFn, SendBytesFn> Unpin for UseWebsocketReturn<OpenFn, CloseFn, SendFn, SendBytesFn>
where OpenFn: Unpin, CloseFn: Unpin, SendFn: Unpin, SendBytesFn: Unpin,

§

impl<OpenFn, CloseFn, SendFn, SendBytesFn> !UnwindSafe for UseWebsocketReturn<OpenFn, CloseFn, SendFn, SendBytesFn>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more