leptos_use

Struct UseBroadcastChannelReturn

Source 
pub struct UseBroadcastChannelReturn<T, PFn, CFn, C>
where
    T: Send + Sync + 'static,
    PFn: Fn(&T) + Clone,
    CFn: Fn() + Clone,
    C: Encoder<T> + Decoder<T> + Send + Sync,
{
    pub is_supported: Signal<bool>,
    pub channel: Signal<Option<BroadcastChannel>, LocalStorage>,
    pub message: Signal<Option<T>>,
    pub post: PFn,
    pub close: CFn,
    pub error: Signal<Option<UseBroadcastChannelError<<C as Encoder<T>>::Error, <C as Decoder<T>>::Error>>, LocalStorage>,
    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>, LocalStorage>

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<<C as Encoder<T>>::Error, <C as Decoder<T>>::Error>>, LocalStorage>

Latest error as reported by the messageerror event.

§is_closed: Signal<bool>

Wether the channel is closed

Auto Trait Implementations§

§

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

§

impl<T, PFn, CFn, C> RefUnwindSafe for UseBroadcastChannelReturn<T, PFn, CFn, C>
where PFn: RefUnwindSafe, CFn: RefUnwindSafe,

§

impl<T, PFn, CFn, C> Send for UseBroadcastChannelReturn<T, PFn, CFn, C>
where PFn: Send, CFn: Send,

§

impl<T, PFn, CFn, C> Sync for UseBroadcastChannelReturn<T, PFn, CFn, C>
where PFn: Sync, CFn: Sync,

§

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

§

impl<T, PFn, CFn, C> UnwindSafe for UseBroadcastChannelReturn<T, PFn, CFn, C>
where PFn: UnwindSafe, CFn: UnwindSafe,

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, 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<El, T, Marker> IntoElementMaybeSignal<T, Marker> for El
where El: IntoElementMaybeSignalType<T, Marker>, Marker: ?Sized,

Source§

fn into_element_maybe_signal(self) -> ElementMaybeSignal<T>

Source§

impl<T, Js> IntoElementMaybeSignalType<T, Element> for Js
where T: From<Js> + Clone,

Source§

fn into_element_maybe_signal_type(self) -> ElementMaybeSignalType<T>

Source§

impl<El, T, Marker> IntoElementsMaybeSignal<T, Marker> for El
where El: IntoElementsMaybeSignalType<T, Marker>, Marker: ?Sized,

Source§

fn into_elements_maybe_signal(self) -> ElementsMaybeSignal<T>

Source§

impl<T, Js> IntoElementsMaybeSignalType<T, Element> for Js
where T: From<Js> + Clone,

Source§

fn into_elements_maybe_signal_type(self) -> ElementsMaybeSignalType<T>

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T