ContiguousBytes での Span 採用

ContiguousBytes プロトコルを ~Copyable かつ ~Escapable に拡張し、RawSpan を用いた安全な版である withBytes を新たに追加します。あわせて Span / MutableSpan / RawSpan / MutableRawSpan / OutputSpan / OutputRawSpan / UTF8Span / InlineArray を ContiguousBytes に適合させます。

ContiguousBytes の一般化と withBytes の追加

プロトコル定義は次のようになります。

public protocol ContiguousBytes: ~Escapable, ~Copyable {
    func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R

    func withBytes<R, E>(_ body: (RawSpan) throws(E) -> R) throws(E) -> R
}

withBytes はクロージャに RawSpan を渡します。RawSpan は non-escapable なので、その寿命がクロージャ呼び出しの範囲を越えないことが型レベルで保証されます。withUnsafeBytes と違って利用側のお作法に頼らずに済むため、より安全です。エラーの扱いも rethrows ではなく typed throws にしてあり、エラー型を正確に伝えられ、Embedded Swift とも相性がよくなっています。

既存の適合型のソース互換性のため、withBytes には withUnsafeBytes を経由するデフォルト実装が用意されます。

extension ContiguousBytes where Self: ~Escapable, Self: ~Copyable {
    public func withBytes<R, E>(_ body: (RawSpan) throws(E) -> R) throws(E) -> R { ... }
}

このため、すでに ContiguousBytes に適合している型は何もしなくても新しい withBytes を呼べるようになります。

Span 系と InlineArray の適合

RawSpan / MutableRawSpan / OutputRawSpan / UTF8Span は無条件で ContiguousBytes に適合します。

extension RawSpan: ContiguousBytes { }
extension MutableRawSpan: ContiguousBytes { }
extension OutputRawSpan: ContiguousBytes { }
extension UTF8Span: ContiguousBytes {
    public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R { ... }
}

要素を持つ Span / MutableSpan / OutputSpan / InlineArray は、Array や UnsafeBufferPointer が以前からそうであったように、Element == UInt8 のときだけ条件付きで適合します。

extension Span: ContiguousBytes where Element == UInt8 { }
extension MutableSpan: ContiguousBytes where Element == UInt8 { }
extension OutputSpan: ContiguousBytes where Element == UInt8 { }
extension InlineArray: ContiguousBytes where Element == UInt8 {
    public func withUnsafeBytes<R, E>(_ body: (UnsafeRawBufferPointer) throws(E) -> R) throws(E) -> R { ... }
}

これにより、Span 系の値をそのまま ContiguousBytes を介したジェネリック API に渡せるようになります。

各型ごとの withBytes 実装

各具体型には、プロトコル要件よりわずかに一般的な withBytes 実装が用意されます。結果型 R を non-copyable にできる点が違いです。

public func withBytes<R: ~Copyable, E>(_ body: (RawSpan) throws(E) -> R) throws(E) -> R

プロトコル要件自体で R: ~Copyable を許してしまうと、既存の withUnsafeBytes ベースのデフォルト実装が成立せずソース互換性が壊れるため、プロトコル要件は R を copyable のままに保ち、具体型側でだけ non-copyable な結果を扱えるようにしています。

既存 API の一般化

ContiguousBytes を制約に持つ既存のジェネリック API は、Bytes: ~Copyable, ~Escapable を加えることで Span 系も受け付けられるようになります。

func encrypt<Bytes: ContiguousBytes>(_ bytes: Bytes) -> [UInt8] { ... }

たとえば上の API は次のように書き換えられます。

func encrypt<Bytes: ContiguousBytes>(_ bytes: Bytes) -> [UInt8]
    where Bytes: ~Copyable, Bytes: ~Escapable {
    ...
}

この変更はソース互換ですが、ABI 安定な API では注意が必要です。実装が値の暗黙コピーを行っていた場合、non-copyable な型を受け取ると実行時にクラッシュする可能性があります。ABI 互換を保ちつつ拡張したい場合は、SE-0476 で導入された @abi 属性を使い、~Escapable のみを許して Copyable 要件は保つのが安全です。

@abi(func encrypt<Bytes: ContiguousBytes>(_ bytes: Bytes) -> [UInt8])
func encrypt<Bytes: ContiguousBytes>(_ bytes: Bytes) -> [UInt8]
    where Bytes: ~Escapable {
    ...
}

この場合、MutableSpan のような non-copyable な型は受け取れませんが、実行時のクラッシュを避けられます。

なお、SE-0458 で導入された strict memory safety モードを有効にすると、UnsafeBufferPointer 系の利用箇所には unsafe 指定が必要になります。これに合わせて、withUnsafeBytes を使っているコードを withBytes に置き換えていくことが推奨されます。