Skip to main content

UseBroadcastChannelReturn

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: OptionLocalSignal<BroadcastChannel>,
    pub message: Signal<Option<T>>,
    pub post: PFn,
    pub close: CFn,
    pub error: OptionLocalSignal<UseBroadcastChannelError<<C as Encoder<T>>::Error, <C as Decoder<T>>::Error>>,
    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: OptionLocalSignal<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: OptionLocalSignal<UseBroadcastChannelError<<C as Encoder<T>>::Error, <C as Decoder<T>>::Error>>

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 Signal<Option<T>>: Freeze, PFn: Freeze, CFn: Freeze, OptionLocalSignal<UseBroadcastChannelError<<C as Encoder<T>>::Error, <C as Decoder<T>>::Error>>: Freeze,

§

impl<T, PFn, CFn, C> RefUnwindSafe for UseBroadcastChannelReturn<T, PFn, CFn, C>
where Signal<Option<T>>: RefUnwindSafe, PFn: RefUnwindSafe, CFn: RefUnwindSafe, OptionLocalSignal<UseBroadcastChannelError<<C as Encoder<T>>::Error, <C as Decoder<T>>::Error>>: RefUnwindSafe,

§

impl<T, PFn, CFn, C> Send for UseBroadcastChannelReturn<T, PFn, CFn, C>
where Signal<Option<T>>: Send, PFn: Send, CFn: Send, OptionLocalSignal<UseBroadcastChannelError<<C as Encoder<T>>::Error, <C as Decoder<T>>::Error>>: Send,

§

impl<T, PFn, CFn, C> Sync for UseBroadcastChannelReturn<T, PFn, CFn, C>
where Signal<Option<T>>: Sync, PFn: Sync, CFn: Sync, OptionLocalSignal<UseBroadcastChannelError<<C as Encoder<T>>::Error, <C as Decoder<T>>::Error>>: Sync,

§

impl<T, PFn, CFn, C> Unpin for UseBroadcastChannelReturn<T, PFn, CFn, C>
where Signal<Option<T>>: Unpin, PFn: Unpin, CFn: Unpin, OptionLocalSignal<UseBroadcastChannelError<<C as Encoder<T>>::Error, <C as Decoder<T>>::Error>>: Unpin,

§

impl<T, PFn, CFn, C> UnsafeUnpin for UseBroadcastChannelReturn<T, PFn, CFn, C>
where Signal<Option<T>>: UnsafeUnpin, PFn: UnsafeUnpin, CFn: UnsafeUnpin, OptionLocalSignal<UseBroadcastChannelError<<C as Encoder<T>>::Error, <C as Decoder<T>>::Error>>: UnsafeUnpin,

§

impl<T, PFn, CFn, C> UnwindSafe for UseBroadcastChannelReturn<T, PFn, CFn, C>
where Signal<Option<T>>: UnwindSafe, PFn: UnwindSafe, CFn: UnwindSafe, OptionLocalSignal<UseBroadcastChannelError<<C as Encoder<T>>::Error, <C as Decoder<T>>::Error>>: 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<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
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>,

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

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<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<T> SerializableKey for T

Source§

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more
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 = !

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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more