archive-gh-me/yew
1
0
Fork 0
mirror of https://github.com/yewstack/yew.git synced 2025-12-08 21:26:25 +00:00
Code Issues Projects Releases Wiki Activity

Fix #2506 and improve some related documentation (#2507)

Browse Source
This commit is contained in:
WorldSEnder 2022-03-10 15:37:12 +01:00 committed by GitHub
parent 51238fb0e3
commit 889c6ba74e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
packages/yew/src/html/component/scope.rs
View File

@ -402,13 +402,11 @@ mod feat_io {
use crate::io_coop::spawn_local;
impl<COMP: BaseComponent> Scope<COMP> {
/// This method creates a [`Callback`] which returns a Future which
/// returns a message to be sent back to the component's event
/// loop.
/// This method creates a [`Callback`] which, when emitted, asynchronously awaits the
/// message returned from the passed function before sending it to the linked component.
///
/// # Panics
/// If the future panics, then the promise will not resolve, and
/// will leak.
/// If the future panics, then the promise will not resolve, and will leak.
pub fn callback_future<FN, FU, IN, M>(&self, function: FN) -> Callback<IN>
where
M: Into<COMP::Message>,
@ -425,8 +423,8 @@ mod feat_io {
closure.into()
}
/// This method processes a Future that returns a message and sends it back to the component's
/// loop.
/// This method asynchronously awaits a [Future] that returns a message and sends it
/// to the linked component.
///
/// # Panics
/// If the future panics, then the promise will not resolve, and will leak.
@ -443,17 +441,19 @@ mod feat_io {
spawn_local(js_future);
}
/// Registers a Future that resolves to multiple messages.
/// Asynchronously send a batch of messages to a component. This asynchronously awaits the
/// passed [Future], before sending the message batch to the linked component.
///
/// # Panics
/// If the future panics, then the promise will not resolve, and will leak.
pub fn send_future_batch<F>(&self, future: F)
where
F: Future<Output = Vec<COMP::Message>> + 'static,
F: Future + 'static,
F::Output: SendAsMessage<COMP>,
{
let link = self.clone();
let js_future = async move {
let messages: Vec<COMP::Message> = future.await;
link.send_message_batch(messages);
future.await.send(&link);
};
spawn_local(js_future);
}