[Swift] コードスニペット subscript

環境＆対象

subscript とは？

Swift での オブジェクトにアクセスする手段の１つです。

配列(Array)要素 では よく見る表現が、names が Array<String> として定義されている時に、names[0] というアクセスです。
このアクセスは、保持されている最初の String 要素へのアクセスになります。

Swift では、このような 角括弧( [ ] のこと) を使ったアクセスは、subscript(s) と呼ばれます。

The Swift Programming Language でのドキュメントは、こちら。

subscript を定義する(read-write)

以下は、subscript を定義する方法です。例では、角括弧内に与える引数は Int で、返り値も Int として書かれていますが、あくまで例です。

  subscript(index: Int) -> Int {
      get {
          // Return an appropriate subscript value here.
      }
      set(newValue) {
          // Perform a suitable setting action here.
      }
  }

subscript を定義する(read-only)

computed property などと同じように、get だけできる subscript を定義することも可能です。以下のようになります。
read-write の例と同様に、使用されている型 Int は、あくまで例です。

  subscript(index: Int) -> Int {
      get {
          // Return an appropriate subscript value here.
      }
  }

get しか定義しないのであれば、以下のように記述を省略することができます。

  subscript(index: Int) -> Int {
      // Return an appropriate subscript value here.
  }

なお、set のみ定義することはできません。

まとめ

角括弧を使ったオブジェクトへのアクセス (subscript) の定義方法

説明は以上です。
不明な点やおかしな点ありましたら、こちらまで。

Swift学習におすすめの本

詳解Swift

Swift の学習には、詳解 Swift という書籍が、おすすめです。

著者は、Swift の初期から書籍を出していますし、Swift の前に主力言語だった Objective-C という言語についても同様の書籍を出しています。

[Swift] Generics を使って RingBuffer を作る [SwiftUI] List の要素削除 の実装方法 [Swift][SwiftUI] actor を使って、LifeGame を作る(その１: actor でモデルを作る) [TDD][SwiftUI] SwiftUI と TDD で作る ボーリングスコアアプリ(その６ 使い勝手を整える)