Borrow and Mutate Accessors

コンテキスト依存のキーワード borrow と mutate を使う、新しい非コルーチン型のアクセサを導入します。yielding borrow / yielding mutate のコルーチン版が yield で値を貸し出していたのに対し、borrow / mutate アクセサはふつうの関数のように return で stored property を返します。

struct RigidWrapper<Element: ~Copyable>: ~Copyable {
    var _element: Element
    var element: Element {
        borrow {
            return _element
        }
        mutate {
            return &_element
        }
    }
}

borrow は読み取り専用の借用として、mutate はインプレースな変更も許す借用として値を公開します。mutate の return には & を付けます。return キーワードは、ほかの関数と同様に本体が単一の式のときは省略できます。

戻せるのは「生きている stored 値」だけ

borrow / mutate アクセサが返せるのは、アクセサの実行を超えて生き続けることが保証された stored な値だけです。ローカル変数や一時値は返せません。

struct InvalidExamples {
    var _array : [Int]

    var local: [Int] {
        borrow {
            let foo = [1, 2, 3]
            // 🛑 ERROR: Cannot return local value from borrow accessor
            return foo
        }
    }

    var temporary: [Int]? {
        borrow {
            // `_array` から一時的に `Optional` を作る必要があるのでNG
            // 🛑 ERROR: Cannot return temporary value from borrow accessor
            return _array
        }
    }
}

この制約により、たとえば _s: String? をそのまま返す borrow は書けますが、i?.s のように optional chaining で nil の場合の String?.none を生み出すような式は返せません。

呼び出し側の振る舞い

borrow で実装されたプロパティの読み出し構文は get の場合と同じですが、コピーは発生しません。借用中は exclusivity ルールにより、親の値を変更することはできません。

var owner = Wrapper(value)

doSomething(with: owner.element)

func doSomething(with value: borrowing Element) {
    value.someMethod()

    // 借用中は親のミューテーションは禁止
    owner.mutatingMethod() // 🛑 ERROR
}

mutate で実装されたプロパティは inout 引数への渡し方などで読み書き両方ができます。こちらも借用中は親に触れられません。

var owner = Wrapper(value)

doSomeMutation(with: &owner.element)

func doSomeMutation(with value: inout Element) {
    value.someMutatingMethod()

    owner.anyMethod() // 🛑 ERROR
}

他アクセサとの併用ルール

borrow / mutate を使うときは、次のルールに従う必要があります。

• mutate を定義する場合、borrow も必ず定義します。Swiftは一般に書き込み専用プロパティを許しておらず（set のみのプロパティが禁じられているのと同じ理由）、さらに読み書きのアクセススコープを揃えることで、コンパイラが読み書き混在の操作を一つの mutate アクセスにまとめて最適化する余地を残したいためです。
• mutate を定義する場合、yielding mutate と yielding borrow は併用できません。
• borrow を定義する場合、get や yielding borrow は併用できません。

読み書きそれぞれで複数のアクセサを同時に定義することは、呼び出し側からどれが実際に使われるのか分かりにくくなるため禁止されています。ABI維持のためにコンパイラが別のアクセサを合成することはありますが、その場合はABI上の規則によりどれが使われるかが一意に決まります。

mutating / nonmutating 修飾子

既定では、borrow は親の値を変更しないアクセサ、mutate は親の値を変更するアクセサとして扱われます。mutating get / nonmutating set と同じ要領で、これを明示的に上書きできます。

mutating borrow は、呼び出し側からは読み取りにしか使えないものの、アクセサ内部で親の値に副作用が及ぶ可能性があることを表します。この場合、イミュータブルな値に対しては呼び出せません。

struct S1 {
  private var cachedValue: Foo
  var foo : Foo {
    mutating borrow {
      if !cachedValue.available {
        // `mutating` なのでここでの更新が許される
      }
      return cachedValue
    }
  }
}

let s1: S1
s1.foo // 🛑 Cannot use mutating accessor on immutable value

逆に nonmutating mutate は、アクセサが可変な借用を返すものの、その変更は親の値の変更とはみなされないことを表します。親の外部に保持されている値への参照を返すようなケースで有用です。

struct Outer {
  var inner: InnerType {
    borrow {
      return some_value_stored_elsewhere
    }
    nonmutating mutate {
      return &some_value_stored_elsewhere
    }
  }
}

プロトコル要件としての borrow / mutate

borrow / mutate はプロトコル要件としても書けます。

protocol BorrowingAccess {
  associatedtype Element
  var element: Element { borrow mutate }
}

プロトコルでアクセサを要求すると、（1）そのプロトコル越し（既存型や制約付きジェネリック引数）にプロパティをどう触れるかが決まり、（2）適合型はそのアクセサを提供する必要があります。適合型が stored property を持っていれば、コンパイラが borrow / mutate を合成できます。適合型が borrow を提供していれば、そこから yielding borrow や（copyable な場合に限り）get を合成できます。mutate を提供していれば set や yielding mutate を合成できます。

プロトコルが borrow を要求する場合、適合型は borrow を明示的に提供する必要があります。mutate を要求する場合は、mutate と borrow の両方を明示的に提供する必要があります。

クラスとアクターでは使えない

クラスやアクターのプロパティアクセスは、アクセスの前後両方で実行時の exclusivity チェックが必要です。borrow / mutate アクセサにはアクセス後に処理を差し挟む仕組みがないため、クラスやアクターのプロパティには使えません。コルーチン版の yielding borrow / yielding mutate は引き続きクラスのプロパティに使えます。

class ClassType {
  private var _value: SomeType
  var value: SomeType {
    borrow {
      // 🛑 Cannot use borrow to implement a property of a class or actor type
      return _value
    }
  }
}

subscriptでの利用

subscriptにも同じように書けます。

struct ArrayLikeType {
  subscript(index: Int) -> Element {
    borrow { .... }
    mutate { .... }
  }
}

subscriptの borrow / mutate アクセスは、アクセス中は構造体全体をアクセス対象とみなします。そのため、同じ値への2つのミューテーティングアクセスを同時に持つような呼び出しは禁止されます。

var x: ArrayLikeType
swap(&x[0], &x[1]) // 🛑 同時に2つの mutate アクセスが必要になる

グローバル変数

グローバル var を borrow / mutate することはできません。グローバル let については borrow は可能ですが、mutate はできません。

var mutableGlobal: SomeType
let constantGlobal: SomeType

struct BorrowingGlobals {
  var mutable: SomeType {
    borrow {
      // 🛑 Cannot borrow a mutable global
      return mutableGlobal
    }
    mutate {
      // 🛑 Cannot mutate a mutable global
      return &mutableGlobal
    }
  }

  var constant: SomeType {
    borrow {
      // OK
      return constantGlobal
    }
    mutate {
      // 🛑 Cannot mutate a non-mutable value
      return &constantGlobal
    }
  }
}

採用時の注意

既存の非 borrow 系アクセサと borrow / mutate の間の切り替えは、一般にABI破壊になります。existential型のABIは、コンパイラが適合アクセサを合成できる限りにおいて保たれます。

また、get を borrow に変更すると、呼び出し側に対して借用中のlifetime制約が新たに課されるため、これまでコンパイルできていたコードがコンパイルできなくなる可能性があり、ソースレベルでも破壊的変更になり得ます。

今後の展望

今回は stored property を直接返す形に限定されていますが、周辺の拡張が将来の方向性として議論されています（speculativeなもので、実現を約束するものではありません）。

• borrowing return: 関数の戻り値として借用値を返せるようにする拡張です。たとえばsubscriptの borrow アクセサで取得した値を、そのまま別のメソッドから borrowing Value として返せるようになります。
• unsafe pointer経由の borrow: UnsafePointer<Element> のような型は、コンパイラがlifetimeを正確に追跡できないため、そのままでは borrow アクセサから返せません。unsafeResultDependsOnSelf(...) のような印を付けて、「結果の値は次の self のミューテーションまで有効である」とユーザ側から宣言できるような仕組みが検討されています。
• 複数の return: 現在の実装では、borrow / mutate 内に return 文を一つしか書けません。将来的に条件分岐で複数の stored property のうちどれを返すかを切り替えられるようにすることが想定されています。
• borrowing switch との組み合わせ: borrowing switch の実装上の制約が解消されれば、enum の各ケースで異なる値を借用して返すような書き方もサポートされる見込みです。
• ローカルな computed property: 関数内で borrow / mutate を使ったcomputed propertyを定義できるようにする方向も検討されています。
• クラスの let プロパティ: 将来的には、クラスの let プロパティに対して borrow アクセサを提供できるようにすることが想定されています。