swift: Variable i was never mutated in `.enumerated()` for var loop; needs fix-it to suggest `for case (let _, var _)`

Description

Hello!

When using a for var (i, element) in elements.enumerated() loop that only modifies element, I receive this warning:

warning: variable 'i' was never mutated; consider changing to 'let' constant
        for var (i, element) in elements.enumerated() { 

~However, there’s no way to only mark i as let, meaning this warning is stuck forever. This feels like a bug, as (imo) there should be a way to indicate one element of the EnumeratedSequence tuple (is it a tuple?) is immutable, and one is mutable.~ ☂️(Edit: there is! From @AnthonyLatsis’s comment below: for case (let i, var element) ...

I assumed (i, element) from .enumerated() worked as an “opaque” tuple, where the tuple is itself mutable, and modifying b in (a, b) constitutes modifying (a, b) vs. just (b).

Reproduction


protocol ManuallyOrderable {
    var index: Int? { get set }
}

struct Reverser<T: ManuallyOrderable> {
    func reverse(elements: [T]) {
        // Writable local copy for ease of demo
        var elements = elements

        // Workaround
        for i in elements.indices {
            elements[i].index = i
        }

        // ⚠️ warning: variable `i` was never mutated
        for var (i, element) in elements.enumerated() {
            element.index = i
        }
    }
}

Expected behavior

The warning could use a fix-it to suggest the proper syntax – or, potentially, the syntax could allow the use of let, var directly without case.


// ⚠️ warning: variable `i` was never mutated
for var (i, element) in elements.enumerated() {
    element.index = i
}

// ✅ Correct syntax
for case (let i, var element) in elements.enumerated() {
    element.index = i
}

// 👀 Additional suggestion
for (let i, var element) in elements.enumerated() {
    element.index = i
}

Environment

Apple Swift version 5.10 (swiftlang-5.10.0.13 clang-1500.3.9.4) Target: arm64-apple-macosx14.0

Additional information

No response

About this issue

  • Original URL
  • State: closed
  • Created 3 years ago
  • Comments: 15 (6 by maintainers)

Most upvoted comments

@AnthonyLatsis @peterkos I noticed you can actually do:

do {
  let s: [(Int, Int)] = [(1, 2)]
  for (i, var x) in s {
    x = i
    // do something with x
    _ = x
  }
}

And i will be implicitly let. Should this be the fix-it (i.e. as opposed to case)?

Reduced:

do {
  let s: [(Int, Int)]
  for var (_, x2) in s {
    _ = x2
  }
}

However, there’s no way to only mark i as let

There is, though not at all obvious because of how used we are to the for x (aka for case let x) pattern matching sugar in for-in statements: for case (let i, var element)

This needs a targeted fix-it.