CBATTRequestは値渡しか参照渡しか

Question

##前提・実現したいこと
didReceiveReadで受け取ったCBATTRequestを、別の関数で識別・request.valueの書き換えを行い、呼び出し元の関数でrespondするプログラムを作成しました。
Swiftは基本的にinoutをつけない限り値渡しである認識しています。
つまり、別の関数でrequest.valueを書き換えたとしても、呼び出し元のdidReceiveReadへは反映されないと考えていました。
しかし、下記コードは正常に動作し、Centralで受け取ったデータは正しく変更されています。
なぜこのコードで正常動作するのかがわかりません。

また試しに呼び出し先の引数requestへinoutをつけましたが、
didReceiveReadの引数requestはletの変数なのでinoutはつけられないとエラーが出ました。

どなたか何故このような挙動ができるのかお分かりになる方がいらっしゃいましたら
教えていただけると幸いです。

##該当のソースコード

static var counter: UInt16 = 0

......

let prop1: CBCharacteristicProperties   = [.read]
let perm1: CBAttributePermissions       = [.readable]
let prop2: CBCharacteristicProperties   = [.read,.write]
let perm2: CBAttributePermissions       = [.readable]

/// skipCharacteristicのvalueを作成
var Number: UInt16 =  12345
var byteArray = [UInt8]()
byteArray.append(contentsOf: withUnsafeBytes(of: &Number){ $0.map{ UInt8($0) } })
let data: Data = Data(byteArray)

skipCharacteristic  = CBMutableCharacteristic(type: UUID1, properties: prop1, value: data, permissions: perm1)
inCharacteristic    = CBMutableCharacteristic(type: UUID2, properties: prop2, value: nil, permissions: perm2)

......

func peripheralManager(_ peripheral: CBPeripheralManager, didReceiveRead request: CBATTRequest) {
    /// readRequestの処理
    let canAnswerRequest = answerReadRequest(request: request)
    
    if canAnswerRequest {
        peripheralManager.respond(to: request, withResult: CBATTError.success)
    } else {
        peripheralManager.respond(to: request, withResult: CBATTError.invalidHandle)
    }
}
    
/// request を個別に処理する関数
func answerReadRequest(request: CBATTRequest) -> Bool{
    var result: Bool = true

    if ( request.characteristic.uuid == UUID1 ) {
        print("recieve skipCharacteristic")
        request.value = skipCharacteristic!.value
        peripheralManager.respond(to: request, withResult: .success)
    } else if ( request.characteristic.uuid == UUID2 ) {
        print("recieve inCharacteristic")
        let newData = makeData()
        request.value = data
        inCharacteristic.value = data
        _ = peripheralManager.updateValue(inCharacteristic!.value!, for: inCharacteristic!, onSubscribedCentrals: nil)
    } else {
        /// ここに入った場合のみ失敗
        print("unknown request")
        print("uuid = (request.characteristic.uuid)")
        result = false
    }

    return result
}

func makeData() -> Data{
    myClass.counter += 1
    var array = [UInt8]()
    array.append(contentsOf: withUnsafeBytes(of: &myClass.counter){ $0.map{ UInt8($0) } })

    let returnData = Data(array)

    return returnData
}

Answer 1

Swiftは基本的にinoutをつけない限り値渡しである認識しています。

　Swiftに限らず、多くの言語では値渡しで行われます。ただ、値渡しで渡される内容が異なります。
Swiftの場合、Intなどのプリミティブやstructなどはオブジェクト全体が値渡しされます。一方で、classはオブジェクトの参照の値が渡されます。

CBATTRequestはクラスなので参照の値が渡されます。そのため、requestを書き換えても呼び出し元のrequestは書き換わりません(ただし、現在のSwiftは仮引数をlet扱いするのでそもそも書き換えができません)が、値(=参照)が指し示す先であるrequestの中身は書き換えることができます。その一方で、inoutを付加すると参照渡しになるので、呼び出し元のrequst自身を書き換えることができます。

Comments

[saku_panda]

ご回答ありがとうございます。
とても分かりやすく、助かりました。
クラスはオブジェクトの参照値を渡すんですね。
inoutをつけた場合とそうでない場合も記述していただけ、理解が深まりました。
ありがとうございました。

Answer 2

「値/参照渡し」は迂闊に使うと戦争が起こる怖い言葉なので
Swiftのリファレンスに沿って説明します。(もうベストアンサーついてますが。)

リファレンスのInoutを読むと

「関数のパラメータはデフォルトで定数である。関数内でパラメータの値を書き換えようとするとコンパイルエラーとなる」
「関数内でパラメータの値を変更して、関数が終わってもその変更を維持したい場合にin-out parameterを使う」
とあります。
これを読んでもたしかに質問のようなことを疑問に思うかもしれませんが、
ここで重要なのは「パラメータの値」が何を意味しているかです。

渡されているパラメータの型:CBATTRequestはclassです。
リファレンスのClassについて読むと、
classはReference Typeである。
と書かれています。
これに続いてReference Typeとは、
「代入時や関数へ渡されるときに、コピーではなく同じインスタンスへの参照(reference)が使われる。」
と書かれています。

というわけで、質問文のコードにおいて、
request.valueの書き換えは「requestが参照しているインスタンスのvalueプロパティの書き換え」であって
requestの値(=どのインスタンスを参照しているか)は変更してないのでinoutをつけなくても合法です。

(なので仮に request = ...というコードを書く場合はinoutを付ける必要があります。)

Comments

[saku_panda]

公式を引用してのご解説ありがとうございます。
また

> request.valueの書き換えは「requestが参照しているインスタンスのvalueプロパティの書き換え」であって
> requestの値(=どのインスタンスを参照しているか)は変更してないのでinoutをつけなくても合法です。

上記の理解を深めたいと思っていたので、助かりました。
ベストアンサー決定後にも関わらず詳しい解説をありがとうございました。

Answer 3

Swiftは基本的にinoutをつけない限り値渡しである認識しています。

引数にしたときに参照渡しされるか値渡しになるかは、変数の種類によって変わります。

classは参照渡しです。structとenumは値が渡されます。

CBATTRequestはclassなので、参照渡しです。inoutがなくても、もともと参照渡しなので、渡されたオブジェクトの内容を変更することができます。

Comments

[saku_panda]

ご回答ありがとうございます。
クラスの参照渡しについての理解が不足しておりました。
ありがとうございました。