FuelLabs/sway

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

Open

#3,925 opened on Jan 30, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (5,421 forks)batch import
P: lowgood first issue

Repository metrics

Stars
 (61,702 stars)
PR merge metrics
 (Avg merge 5d 4h) (19 merged PRs in 30d)

Description

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.

Contributor guide

Research direction
Monitor the stabilization of `BTreeMap::drain filter` in Rust nightly, then replace the `retain` call with `drain filter` in swayfmt/src/comments.rs.
Tech stack
rust
Domain
tooling
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70