leptos_use

Struct UseWebSocketReturn

Source 
pub struct UseWebSocketReturn<Tx, Rx, OpenFn, CloseFn, SendFn>
where
    Tx: 'static,
    Rx: 'static,
    OpenFn: Fn() + Clone + 'static,
    CloseFn: Fn() + Clone + 'static,
    SendFn: Fn(&Tx) + Clone + 'static,
{
    pub ready_state: Signal<ConnectionReadyState>,
    pub message: Signal<Option<Rx>>,
    pub ws: Signal<Option<WebSocket>>,
    pub open: OpenFn,
    pub close: CloseFn,
    pub send: SendFn,
    /* private fields */
}
Expand description

Return type of use_websocket.

Fields§

§ready_state: Signal<ConnectionReadyState>

The current state of the WebSocket connection.

§message: Signal<Option<Rx>>

Latest message received from WebSocket.

§ws: Signal<Option<WebSocket>>

The WebSocket instance.

§open: OpenFn

Opens the WebSocket connection

§close: CloseFn

Closes the WebSocket connection

§send: SendFn

Sends data through the socket

Trait Implementations§

Source§

impl<Tx, Rx, OpenFn, CloseFn, SendFn> Clone for UseWebSocketReturn<Tx, Rx, OpenFn, CloseFn, SendFn>
where Tx: 'static + Clone, Rx: 'static + Clone, OpenFn: Fn() + Clone + 'static + Clone, CloseFn: Fn() + Clone + 'static + Clone, SendFn: Fn(&Tx) + Clone + 'static + Clone,

Source§

fn clone(&self) -> UseWebSocketReturn<Tx, Rx, OpenFn, CloseFn, SendFn>

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<Tx, Rx, OpenFn, CloseFn, SendFn> Freeze for UseWebSocketReturn<Tx, Rx, OpenFn, CloseFn, SendFn>
where OpenFn: Freeze, CloseFn: Freeze, SendFn: Freeze,

§

impl<Tx, Rx, OpenFn, CloseFn, SendFn> !RefUnwindSafe for UseWebSocketReturn<Tx, Rx, OpenFn, CloseFn, SendFn>

§

impl<Tx, Rx, OpenFn, CloseFn, SendFn> !Send for UseWebSocketReturn<Tx, Rx, OpenFn, CloseFn, SendFn>

§

impl<Tx, Rx, OpenFn, CloseFn, SendFn> !Sync for UseWebSocketReturn<Tx, Rx, OpenFn, CloseFn, SendFn>

§

impl<Tx, Rx, OpenFn, CloseFn, SendFn> Unpin for UseWebSocketReturn<Tx, Rx, OpenFn, CloseFn, SendFn>
where OpenFn: Unpin, CloseFn: Unpin, SendFn: Unpin, Tx: Unpin, Rx: Unpin,

§

impl<Tx, Rx, OpenFn, CloseFn, SendFn> !UnwindSafe for UseWebSocketReturn<Tx, Rx, OpenFn, CloseFn, SendFn>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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,

Source§

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>,

Source§

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>,

Source§

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T