leptos_use

Struct UseBroadcastChannelReturn

Source 
pub struct UseBroadcastChannelReturn<T, PFn, CFn, E, D>
where
    T: 'static,
    PFn: Fn(&T) + Clone,
    CFn: Fn() + Clone,
    E: 'static,
    D: 'static,
{
    pub is_supported: Signal<bool>,
    pub channel: Signal<Option<BroadcastChannel>>,
    pub message: Signal<Option<T>>,
    pub post: PFn,
    pub close: CFn,
    pub error: Signal<Option<UseBroadcastChannelError<E, D>>>,
    pub is_closed: Signal<bool>,
}
Expand description

Return type of use_broadcast_channel.

Fields§

§is_supported: Signal<bool>

true if this browser supports BroadcastChannels.

§channel: Signal<Option<BroadcastChannel>>

The broadcast channel that is wrapped by this function

§message: Signal<Option<T>>

Latest message received from the channel

§post: PFn

Sends a message through the channel

§close: CFn

Closes the channel

§error: Signal<Option<UseBroadcastChannelError<E, D>>>

Latest error as reported by the messageerror event.

§is_closed: Signal<bool>

Wether the channel is closed

Auto Trait Implementations§

§

impl<T, PFn, CFn, E, D> Freeze for UseBroadcastChannelReturn<T, PFn, CFn, E, D>
where PFn: Freeze, CFn: Freeze,

§

impl<T, PFn, CFn, E, D> !RefUnwindSafe for UseBroadcastChannelReturn<T, PFn, CFn, E, D>

§

impl<T, PFn, CFn, E, D> !Send for UseBroadcastChannelReturn<T, PFn, CFn, E, D>

§

impl<T, PFn, CFn, E, D> !Sync for UseBroadcastChannelReturn<T, PFn, CFn, E, D>

§

impl<T, PFn, CFn, E, D> Unpin for UseBroadcastChannelReturn<T, PFn, CFn, E, D>
where PFn: Unpin, CFn: Unpin, T: Unpin, E: Unpin, D: Unpin,

§

impl<T, PFn, CFn, E, D> !UnwindSafe for UseBroadcastChannelReturn<T, PFn, CFn, E, D>

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

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