deferred-future

模仿jQuery.Deferred()，允許

• 【地點(diǎn)】從Future實(shí)現(xiàn)類實(shí)例外部

• 【時(shí)間】異步地

改變當(dāng)前Future對(duì)象的Polling狀態(tài)從Poll::Pending至Poll::Ready。這個(gè)痛點(diǎn)是futures crate都沒(méi)有照顧到的。

功能

deferred-future crate分別針對(duì)

• 單線程/WASM

• 多線程

提供了兩套代碼實(shí)現(xiàn)和兩個(gè)自定義cargo feature：

默認(rèn)情況下，local與thread都處于開(kāi)啟狀態(tài)。為了追求極致的編譯時(shí)間（短）與輸出二進(jìn)制文件體積（小），屏蔽掉未被使用的模塊非常有幫助。比如，在WASM工程內(nèi)，啟用【條件編譯】和（編譯時(shí)）“裁剪”依賴包是最明智的：

# 因?yàn)?WASM 不支持【操作系統(tǒng)線程】，所以僅只導(dǎo)入單線程代碼實(shí)現(xiàn) deferred-future = {version = "0.1.0", features = ["local"]}

另外，因?yàn)?code style="background:rgb(251,241,199);font-family:'Source Code Pro', 'Fira Code', Menlo, Monaco, Consolas, 'DejaVu Sans Mono', Inconsolata, 'Courier New', monospace;">deferred-future crate選擇實(shí)現(xiàn)trait futures::FusedFuture，而不僅只是來(lái)自【標(biāo)準(zhǔn)庫(kù)】的std::Future，所以其對(duì)更多“邊界情況”提供了良好的容錯(cuò)支持。比如，

• 重復(fù)地Polling一個(gè)已經(jīng)Poll::Ready(T)的Future實(shí)例不會(huì)導(dǎo)致U.B.。

安裝

不開(kāi)啟【條件編譯】

cargo add deferred-future

面向WASM，推薦僅開(kāi)啟local

cargo add deferred-future --features=local

用法

使用套路概括起來(lái)包括：

1. 構(gòu)造一個(gè)***DeferredFuture實(shí)例

   1. 在多線程上下文中，泛型類型參數(shù)T必須是Send + Sync的。

   2. 在單線程上下文中，前綴***是Local

   3. 在多線程上下文中，前端***是Thread

   4. 泛型類型參數(shù)T對(duì)應(yīng)于Future::Output關(guān)聯(lián)類型 —— 代表了Future就緒后輸出值的數(shù)據(jù)類型

2. 從***DeferredFuture實(shí)例抽取出defer屬性值

   1. 被用來(lái)Wake up處于Pending狀態(tài)***DeferredFuture實(shí)例的complete(T)成員方法就隸屬于此defer對(duì)象。

   2. 在單線程上下文中，defer是Rc>的引用計(jì)數(shù)·智能指針

   3. 在多線程上下文中，defer是Arc>的原子加鎖引用計(jì)數(shù)·智能指針

3. 將defer對(duì)象克隆后甩到（另）一個(gè)異步任務(wù)Task塊中去。

   1. 在異步塊內(nèi)，調(diào)用defer的complete(T)成員方法。

   2. 在單線程上下文中，defer對(duì)象需被可修改借入defer.borrow_mut()。

   3. 在多線程上下文中，需要先成功地獲取線程同步鎖defer.lock().unwrap()。

4. 在當(dāng)前執(zhí)行上下文，阻塞等待***DeferredFuture實(shí)例就緒和返回結(jié)果。

   1. 就單線程而言，當(dāng)前執(zhí)行上下文即是“主線程”，和同步阻塞主線程。

   2. 就多線程而言，當(dāng)前執(zhí)行上下文就是“父異步塊”，和異步阻塞上一級(jí)異步塊。

下面仔細(xì)看代碼例程。請(qǐng)?zhí)貏e留意注釋說(shuō)明。

單線程

use ::LocalDeferredFuture; use ::{future, executor::LocalPool, task::LocalSpawnExt}; use ::{prelude::*, time::Duration}; use ::Instant; // (1) 構(gòu)造·形似 jQuery.Deferred() 的 trait FusedFuture 實(shí)現(xiàn)例類實(shí)例。 // - 注意：泛型類型參數(shù) —— `Future::Output`輸出值類型是字符串。 let deferred_future = LocalDeferredFuture::default(); // (2) 取出它的 defer 實(shí)例。 let defer = deferred_future.defer(); // (3) 發(fā)起一個(gè)異步任務(wù)。在 2 秒鐘后，填入`Future::Output`輸出值。 let mut executor = LocalPool::new(); executor.spawner().spawn_local(async move { future::from_secs(2_u64)).await; // (3.1) 在異步塊內(nèi)，調(diào)用`defer`的`complete(T)`成員方法。 defer.borrow_mut().complete("2秒鐘后才被延遲填入的消息".to_string()); }).unwrap(); // (4) 同步阻塞主線程等待 #3 的異步任務(wù)執(zhí)行結(jié)果，和抽取出`Future::Output`輸出值。 let start = Instant::now(); let message = executor.run_until(deferred_future); // (4.1) 會(huì)造成主線程的同步阻塞 let end = Instant::now(); let elapse = end.duration_since(start).as_secs(); println!("為了收到消息<{}>，主協(xié)程先后等待了 {} 秒", message, elapse);

從命令行，執(zhí)行命令cargo.exe run --example local-usage可直接運(yùn)行此例程。

多線程

use ::ThreadDeferredFuture; use ::{future, executor::{block_on, ThreadPool}, task::SpawnExt}; use ::{prelude::*, time::Duration}; use ::{error::Error, sync::PoisonError, time::Instant}; block_on(async move { // (1) 構(gòu)造·形似 jQuery.Deferred() 的 trait FusedFuture 實(shí)現(xiàn)類實(shí)例。 // - 注意：泛型類型參數(shù) —— `Future::Output`輸出值類型是字符串。 // - String 是 Send + Sync 的數(shù)據(jù)類型，和支持跨線程傳遞的。 let deferred_future = ThreadDeferredFuture::default(); // (2) 取出它的 defer 實(shí)例。 let defer = deferred_future.defer(); // (3) 發(fā)起一個(gè)異步任務(wù)。在 1 秒鐘后，填入`Future::Output`輸出值。 ThreadPool::new()?.spawn(async move { future::from_secs(1_u64)).await; // (3.1) 在異步塊內(nèi)，調(diào)用`defer`的`complete(T)`成員方法。 let mut defer = defer.lock().unwrap_or_else(PoisonError::into_inner); defer.complete("1秒鐘后才被延遲填入的消息".to_string()); })?; // (4) 異步阻塞當(dāng)前 Task 等待 #3 的異步任務(wù)執(zhí)行結(jié)果，和抽取出`Future::Output`輸出值。 let start = Instant::now(); let message = deferred_future.await; // (4.1) 會(huì)造成上一級(jí)異步塊的異步阻塞 let end = Instant::now(); let elapse = end.duration_since(start).as_secs(); println!("為了收到消息<{}>，主協(xié)程先后等待了 {} 秒", message, elapse); Ok(()) })?;

從命令行，執(zhí)行命令cargo.exe run --example thread-usage可直接運(yùn)行此例程。

WASM

use ::LocalDeferredFuture; use ::{EventStream, Options}; // (1) 構(gòu)造·形似 jQuery.Deferred() 的 trait FusedFuture 實(shí)例類實(shí)例。 // - 注意：泛型類型參數(shù) —— `Future::Output`輸出值類型是 u32。 let deferred_future = LocalDeferredFuture::default(); // (2) 取出它的 defer 實(shí)例。 let defer = deferred_future.defer(); // (3) 給按鈕 DOM 元素添加一個(gè)鼠標(biāo)單擊事件。僅當(dāng)按鈕被單擊時(shí)，才填入`Future::Output`輸出值。 let _ = EventStream::on(&button, "click", Options::enable_prevent_default(true), move |event| { // (3.1) 在 DOM 事件處理函數(shù)內(nèi)，調(diào)用`defer`的`complete(T)`成員方法。 defer.borrow_mut().complete(12); future::ready(Ok(())) }); wasm_bindgen_futures::spawn_local(async move { // (4) 異步阻塞當(dāng)前 Task 等待 #3 的按鈕點(diǎn)擊事件的發(fā)生，和抽取出`Future::Output`輸出值。 let result = deferred_future.await; console::info!("DeferredFuture異步結(jié)果", result); });