v2.4.0

[notgull]

• Add a "fuse" method that makes it so a Future returns Poll::Pending
  forever after it returns Poll::Pending once. (add Fuse support to FutureExt #101)
• Add a "stop_after_future" function that allows for running a Stream until a
  Future completes. (feat: add StreamExt::take_until. #103)

[taiki-e]

• a "take_until" method

• It seems that what was actually added was an freestanding function (stream::take_until) not a trait method (StreamExt::take_until)? (The PR title and commit message also says StreamExt::take_until)
• The Iterator::take_while takes FnMut(&Self::Item) -> bool as a predicate. I don't remember if futures had the same method but maybe it takes Fn* which returns a future. Is there any reason why ours decided to take a future compared to those?

[notgull]

Good catch! I forgot to check the equivalent Iterator method, I'll fix.

[notgull]

Actually, on second check I think it's intentional. The idea is "run a stream in parallel with a future and stop the stream when the future stops." I think the idea is this:

let my_stream = /* ... */;
let (signal, shutdown) = async_channel::bounded::<()>(1);

// Send the shutdown signal when the user hits ctrl-c.
executor.spawn(async move {
    wait_for_user_to_hit_ctrl_c().await;
    signal.try_send(()).ok();
}).detach();

// Run until the stream stops.
while let Some(item) = stream::take_until(my_stream, shutdown).next().await {
    do_something(item).await;
}

[taiki-e]

(Honestly, I have no strong opinion on which API to choose here. I just know what the result of inconsistent APIs can be: rust-lang/futures-rs#2755)

[notgull]

I think it's not an inconsistent API, since it's somewhat Stream-specific. However I would be okay with changing the name to distinguish it from any Iterator functions.

[notgull]

I think the name is the core point of confusion here. I've opened #104 to address this.

[notgull]

I've changed the name,

[notgull]

@smol-rs/admins Can someone take a look at this?

[fogti]

clippy is not happy tho about

futures-lite/src/stream.rs

Line 386 in 6f89c8b

(usize::max_value(), None)

maybe that should be fixed before release?
https://productionresultssa15.blob.core.windows.net/actions-results/4c1cf303-e261-4017-bc7f-284bc2eb5ed9/workflow-job-run-3d108b53-2ec6-5cdc-c7d6-8422e74d0ce2/logs/job/job-logs.txt?rsct=text%2Fplain&se=2024-08-14T13%3A27%3A50Z&sig=dgo%2BqhwImVkyDFW26nC3iCe193KGYFvMQmT5S01Ifjo%3D&ske=2024-08-15T00%3A54%3A03Z&skoid=ca7593d4-ee42-46cd-af88-8b886a2f84eb&sks=b&skt=2024-08-14T12%3A54%3A03Z&sktid=398a6654-997b-47e9-b12b-9515b896b4de&skv=2024-05-04&sp=r&spr=https&sr=b&st=2024-08-14T13%3A17%3A45Z&sv=2024-05-04

[notgull]

clippy is not happy tho about

Fixed!