nonexhaustiveなenum

non-resilient なモジュールでも enum を non-exhaustive（拡張可能）として公開できるように、新しい属性 @nonexhaustive を導入します。@nonexhaustive を付けた enum は、resilient ライブラリの非 @frozen な enum と同じ振る舞いになります。

/// Module A
@nonexhaustive
public enum PizzaFlavor {
    case hawaiian
    case pepperoni
    case cheese
}

/// Module B
switch pizzaFlavor { // error: Switch covers known cases, but 'PizzaFlavor' may have additional unknown values, possibly added in future versions
case .hawaiian:
    throw BadFlavorError()
case .pepperoni:
    try validateNoVegetariansEating()
    return .delicious
case .cheese:
    return .delicious
}

別モジュール（かつ別パッケージ）から switch する側は、@unknown default を書いて将来ケースが増えた場合の挙動を明示する必要があります。

switch pizzaFlavor {
case .hawaiian, .pepperoni, .cheese:
    return .delicious
@unknown default:
    return .unknown
}

同一モジュール／パッケージ内では exhaustive のまま

同一モジュールや同一パッケージ内のコードは「一緒に開発される単位」とみなされるため、@nonexhaustive な enum であっても @unknown default なしで exhaustive に switch できます。むしろ不要な @unknown default を書くと警告になります。これにより、ライブラリ作者は自分のコード内では従来通りコンパイラの網羅性チェックを最大限活用しつつ、外部 API としては拡張可能性を確保できます。

@frozen との関係

ある enum に @nonexhaustive と @frozen を同時に付けることはできず、コンパイルエラーになります。両者は exhaustive にするかしないかの真逆の意味を持つ属性なので、混在は禁止です。

resilient モジュールでは元から non-exhaustive が既定なので、@nonexhaustive を付け外ししても挙動は変わりません。

既存の enum を段階的に拡張可能にする @nonexhaustive(warn)

既に公開済みの enum を後から @nonexhaustive 化するのは、利用側の switch をエラーにしてしまうため、API 互換性の観点では破壊的変更 です。これを一段階柔らかく扱うために @nonexhaustive(warn) も用意されます。これは「いずれ拡張可能にしたい」という意思表示で、現時点ではエラーを警告に格下げします。

// Package A の旧バージョン
public enum Foo {
  case foo
}

// Package B
switch foo {
case .foo: break
}

// Package A が将来の拡張に備える
@nonexhaustive(warn)
public enum Foo {
  case foo
}

// Package B 側は警告に格下げされる
switch foo { // warning: Enum might be extended later. Add an @unknown default case.
case .foo: break
}

// 後日 Package A が実際にケースを追加してメジャーアップ
@nonexhaustive(warn)
public enum Foo {
  case foo
  case bar
}

// Package B は @unknown default を未追加のままなのでエラー＋警告
switch foo { // error: Unhandled case bar & warning: Enum might be extended later. Add an @unknown default case.
case .foo: break
}

@nonexhaustive(warn) を付けただけではメジャーバージョンを上げる必要を回避できるわけではありませんが、「将来この enum は拡張するつもりだ」という事前告知として機能し、利用側に @unknown default を足してもらう猶予を与えられます。

なお、@nonexhaustive(warn) を 外す のは、警告で済んでいたものをエラーに昇格させてしまうため API 破壊的変更です。

API 破壊チェッカ

swift package diagnose-api-breaking-changes も新しい属性を理解するように更新され、@nonexhaustive の付与・削除や @nonexhaustive(warn) の削除といった変更が API 破壊として検出されるようになります。