Struct leptos_use::UseEventSourceReturn

source · 
pub struct UseEventSourceReturn<T, Err, OpenFn, CloseFn>
where
    Err: 'static,
    T: Clone + 'static,
    OpenFn: Fn() + Clone + 'static,
    CloseFn: Fn() + Clone + 'static,
{
    pub data: Signal<Option<T>>,
    pub ready_state: Signal<ConnectionReadyState>,
    pub event: Signal<Option<Event>>,
    pub error: Signal<Option<UseEventSourceError<Err>>>,
    pub open: OpenFn,
    pub close: CloseFn,
    pub event_source: Signal<Option<EventSource>>,
}
Expand description

Return type of use_event_source.

Fields§

§data: Signal<Option<T>>

Latest data received via the EventSource

§ready_state: Signal<ConnectionReadyState>

The current state of the connection,

§event: Signal<Option<Event>>

The latest named event

§error: Signal<Option<UseEventSourceError<Err>>>

The current error

§open: OpenFn

(Re-)Opens the EventSource connection If the current one is active, will close it before opening a new one.

§close: CloseFn

Closes the EventSource connection

§event_source: Signal<Option<EventSource>>

The EventSource instance

Auto Trait Implementations§

§

impl<T, Err, OpenFn, CloseFn> Freeze for UseEventSourceReturn<T, Err, OpenFn, CloseFn>
where OpenFn: Freeze, CloseFn: Freeze,

§

impl<T, Err, OpenFn, CloseFn> !RefUnwindSafe for UseEventSourceReturn<T, Err, OpenFn, CloseFn>

§

impl<T, Err, OpenFn, CloseFn> !Send for UseEventSourceReturn<T, Err, OpenFn, CloseFn>

§

impl<T, Err, OpenFn, CloseFn> !Sync for UseEventSourceReturn<T, Err, OpenFn, CloseFn>

§

impl<T, Err, OpenFn, CloseFn> Unpin for UseEventSourceReturn<T, Err, OpenFn, CloseFn>
where OpenFn: Unpin, CloseFn: Unpin, T: Unpin, Err: Unpin,

§

impl<T, Err, OpenFn, CloseFn> !UnwindSafe for UseEventSourceReturn<T, Err, OpenFn, CloseFn>

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