deferred-future
模仿jQuery.Deferred(),允许
- 【地点】从
Future
实现类实例外部 - 【时间】异步地
改变当前Future
对象的Polling
状态从Poll::Pending
至Poll::Ready<T>
。这个痛点是futures crate都没有照顾到的。
功能
deferred-future crate
分别针对
- 单线程/
WASM
- 多线程
提供了两套代码实现和两个自定义cargo feature
:
cargo feature |
FusedFuture 实现类 |
运行上下文 |
---|---|---|
local |
LocalDeferredFuture<T> |
单线程/WASM |
thread |
ThreadDeferredFuture<T> |
多线程 |
默认情况下,local
与thread
都处于开启状态。为了追求极致的编译时间(短)与输出二进制文件体积(小),屏蔽掉未被使用的模块非常有帮助。比如,在WASM
工程内,启用【条件编译】和(编译时)“裁剪”依赖包是最明智的:
# 因为 WASM 不支持【操作系统线程】,所以仅只导入单线程代码实现
= { = "0.1.0", = ["local"]}
另外,因为deferred-future crate
选择实现trait futures::future::FusedFuture,而不仅只是来自【标准库】的std::future::Future,所以其对更多“边界情况”提供了良好的容错支持。比如,
- 重复地
Polling
一个已经Poll::Ready(T)
的Future
实例不会导致U.B.
。
安装
不开启【条件编译】
cargo add deferred-future
面向WASM
,推荐仅开启local
cargo add deferred-future --features=local
用法
使用套路概括起来包括:
- 构造一个
***DeferredFuture<T>
实例- 在单线程上下文中,前缀
***
是Local
- 在多线程上下文中,前端
***
是Thread
- 泛型类型参数
T
对应于Future::Output
关联类型 —— 代表了Future
就绪后输出值的数据类型- 在多线程上下文中,泛型类型参数
T
必须是Send + Sync
的。
- 在多线程上下文中,泛型类型参数
- 在单线程上下文中,前缀
- 从
***DeferredFuture<T>
实例抽取出defer
属性值- 被用来
Wake up
处于Pending
状态***DeferredFuture<T>
实例的complete(T)
成员方法就隶属于此defer
对象。 - 在单线程上下文中,
defer
是Rc<RefCell<T>>
的引用计数·智能指针 - 在多线程上下文中,
defer
是Arc<Mutex<T>>
的原子加锁引用计数·智能指针
- 被用来
- 将
defer
对象克隆后甩到(另)一个异步任务Task
块中去。- 在异步块内,调用
defer
的complete(T)
成员方法。 - 在单线程上下文中,
defer
对象需被可修改借入defer.borrow_mut()
。 - 在多线程上下文中,需要先成功地获取线程同步锁
defer.lock().unwrap()
。
- 在异步块内,调用
- 在当前执行上下文,阻塞等待
***DeferredFuture<T>
实例就绪和返回结果。- 就单线程而言,当前执行上下文即是“主线程”,和同步阻塞主线程。
- 就多线程而言,当前执行上下文就是“父异步块”,和异步阻塞上一级异步块。
下面仔细看代码例程。请特别留意注释说明。
单线程
use LocalDeferredFuture;
use ;
use ;
use Instant;
// (1) 构造·形似 jQuery.Deferred() 的 trait FusedFuture 实现例类实例。
// - 注意:泛型类型参数 —— `Future::Output`输出值类型是字符串。
let deferred_future = default;
// (2) 取出它的 defer 实例。
let defer = deferred_future.defer;
// (3) 发起一个异步任务。在 2 秒钟后,填入`Future::Output`输出值。
let mut executor = new;
executor.spawner.spawn_local.unwrap;
// (4) 同步阻塞主线程等待 #3 的异步任务执行结果,和抽取出`Future::Output`输出值。
let start = now;
let message = executor.run_until; // (4.1) 会造成主线程的同步阻塞
let end = now;
let elapse = end.duration_since.as_secs;
println!;
从命令行,执行命令cargo.exe run --example local-usage
可直接运行此例程。
多线程
use ThreadDeferredFuture;
use ;
use ;
use ;
block_on?;
从命令行,执行命令cargo.exe run --example thread-usage
可直接运行此例程。
WASM
use LocalDeferredFuture;
use future;
use EventStream;
// (1) 构造·形似 jQuery.Deferred() 的 trait FusedFuture 实例类实例。
// - 注意:泛型类型参数 —— `Future::Output`输出值类型是 u32。
let deferred_future = default;
// (2) 取出它的 defer 实例。
let defer = deferred_future.defer;
// (3) 创建一个计划任务。仅当计划任务被执行时,才填入`Future::Output`输出值。
let _ = on_timeout;
// (4) 异步阻塞当前 Task 等待 #3 的按钮点击事件的发生,和抽取出`Future::Output`输出值。
let result = deferred_future.await;
assert_eq!;
从命令行,执行命令wasm-pack test --chrome
可直接运行此例程。
"无头"运行模式
# 开启详细日志
set RUST_LOG=wasm_bindgen_test_runner
# 运行 webdriver
wasm-pack test --chrome --headless --chromedriver=<chromedriver可执行文件完整路径>
注意:需要本地安装的
webdriver
与Chrome
版本匹配。否则,就会收到"error":"invalid session id"
的反馈。查看详细日志就会发现这么一条DEBUG
日志"message":"session not created: This version of ChromeDriver only supports Chrome version 114\nCurrent browser version is 118.0.5993.118 with binary path
。
最后,可从这下载最新版的ChromeDriver
。