FuelLabs/sway

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

Open

Aperta il 30 gen 2023

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Rust (61.702 star) (5421 fork)batch import
P: lowgood first issue

Descrizione

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.

Guida contributor

Tech stack
rust
Dominio
tooling
Tipo issue
refactor
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
RustBTreeMap drain filternightly Rust
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
30
Direzione di ricerca
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.