FuelLabs/sway

refactor(fmt): use `drain_filter` during comment formatting when stabilized

Open

#3,925 建立於 2023年1月30日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Rust (61,702 star) (5,421 fork)batch import
P: lowgood first issue

描述

BTreeMap does not have an equivalent for Range that also removes the yielded elements, however it does have a > drain_filter method.

A more efficient (performance and code-wise) alternative to this function using drain_filter might look like:

formatter.comment_map.drain_filter(|bs, _v| bs.start >= start && bs.end <= end)

Originally posted by @mitchmindtree in https://github.com/FuelLabs/sway/pull/3854#discussion_r1083691334

Currently, drain_filter is a a nightly-only API - I opted to use retain instead to filter out already formatted comments. We can perhaps consider doing this once drain_filter is stabilized.

貢獻者指南

技術棧
rust
領域
tooling
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
RustBTreeMap drain filternightly Rust
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
30
研究方向
This issue proposes replacing `retain` with `drain filter` in comment formatting when that API stabilizes. The relevant code is in swayfmt/src/comments.rs lines 59-64, and the original suggestion came from PR #3854. To proceed, monitor Rust nightly for `drain filter` stabilization, then implement the change. No current activity or assignee.