Opaque result types with limited availability

opaque result type を返す関数のうち、if #available による分岐については「同じ具体型を返す」という制約を緩め、分岐ごとに異なる underlying type を返せるようにします。これにより、プログラムの 1 回の実行中は underlying type が一つに定まるという性質を保ったまま、実行環境（OS バージョン）ごとに別の型を返す API を書けるようになります。

次の例はこの新ルールで受け付けられるようになる典型的な形です。

func test() -> some Shape {
  if #available(macOS 100, *) {
    return Rectangle()
  }
  return self
}

macOS 100 以上で動作しているときは underlying type が Rectangle、それ以外では Square となります。どちらの場合でも「一つの実行において underlying type は一つに決まる」ので、opaque result type の抽象モデルは保たれます。

unconditional availability clause

本 Proposal ではこの特別扱いを受けられる if #available 節を、unconditional availability clause（無条件可用性節）として定義しています。ある if / else if 節がこれに該当するのは、次の条件をすべて満たす場合です。

• その if 文が、関数本体のトップレベルに書かれている。
• その if 文より前に return 文が存在しない。
• 節の条件が #available である。
• 最初の if 節か、または直前の節が unconditional availability clause である else if 節である。
• 節の中に少なくとも一つ return 文がある。
• 節のブロックを通過するすべてのパスが、return または throw で終わる。

unconditional availability clause の外にある return 文どうしは、従来どおり同じ具体型を返す必要があり、その型は関数全体と同じ可用性を持たなければなりません。一方、ある unconditional availability clause の中の return 文どうしも同じ具体型でなければなりませんが、その型は節の外の型と一致している必要はなく、節の #available 条件と同じ可用性を持っていれば十分です。

関数全体には少なくとも一つの return 文が必要です。unconditional availability clause の外に一つも return がない場合は、節の中の型のうち少なくとも一つが関数全体と同じ可用性を持たなければなりません。

動的な戻り型は次のように決まります。

• 最初にマッチした unconditional availability clause の中の return 文の型。
• どの節もマッチしなければ、節の外の return 文の型。
• 節の外に return 文が無い場合は、関数と同じ可用性を持つ最初の unconditional availability clause の型。

許容される書き方・されない書き方

else if #available の連鎖も、直前までが unconditional availability clause である限り許されます。

func test() -> some Shape {
  if #available(macOS 100, *) {
    return Rectangle()
  } else if #available(macOS 99, *) {
    return Square()
  }
  return self
}

逆に、#available が「動的条件（通常の if、guard、switch など）と混ざっている」場合や、「#available より前に return する可能性のある動的条件がある」場合、「#available がループの中にある」場合は、この特別扱いを受けられません。これは、関数の戻り型を「実際に本体を実行せずに、静的に一意に決められる」という性質を保つためです。

// NG: 動的条件に続く else if #available
func test() -> some Shape {
  if cond {
    ...
  } else if #available(macOS 100, *) {
    return Rectangle()
  }
  return self
}

// NG: #available より前に動的条件による return がある
func test() -> some Shape {
  guard let x = optValue else {
    return ...
  }
  if #available(macOS 100, *) {
    return Rectangle()
  }
  return self
}

// NG: ループ内の #available
func test() -> some Shape {
  for ... {
    if #available(macOS 100, *) {
      return Rectangle()
    }
  }
  return self
}

また、unconditional availability clause の内部でさらに分岐する場合は、節の中のすべての return が同じ具体型でなければなりません。

// OK: 節内のすべての return が Rectangle
func test() -> some Shape {
  if #available(macOS 100, *) {
    if cond {
      return Rectangle(...)
    } else {
      return Rectangle(...)
    }
  }
  return self
}

// NG: 節内の return の具体型が Rectangle と Square で食い違う
func test() -> some Shape {
  if #available(macOS 100, *) {
    if cond {
      return Rectangle()
    } else {
      return Square()
    }
  }
  return self
}

この仕組みによって、「プラットフォームごと・そして実行単位ごとに underlying type は常に一つに決まる」という opaque result type の基本モデルを壊すことなく、可用性制限付きの新しい型を既存 API にスムーズに取り込めるようになります。