Swift Firestore Resultについて

Question

Firestoreのドキュメントの中で以下のようなエラー処理について悩んでいます。
参考：Firestore公式

以下の中で、Resultというのはどこから来たのでしょうか？
また、このResultをletでoptionalにしている理由が分かりません。

私が思うには、引数としてのdocumentに対してresultの処理をすれば分かるのですが
成功した値であるdocumentとは別に、Resultを使っている理由が分かりません。
他のコードを見ると、成功したとしてdocumentを使っているからです。

ご教授よろしくお願いいたします。

let docRef = db.collection("cities").document("BJ")

docRef.getDocument { (document, error) in
    // Construct a Result type to encapsulate deserialization errors or
    // successful deserialization. Note that if there is no error thrown
    // the value may still be `nil`, indicating a successful deserialization
    // of a value that does not exist.
    //
    // There are thus three cases to handle, which Swift lets us describe
    // nicely with built-in Result types:
    //
    //      Result
    //        /\
    //   Error  Optional<City>
    //               /\
    //            Nil  City
    let result = Result {
      try document?.data(as: City.self)
    }
    switch result {
    case .success(let city):
        if let city = city {
            // A `City` value was successfully initialized from the DocumentSnapshot.
            print("City: (city)")
        } else {
            // A nil value was successfully initialized from the DocumentSnapshot,
            // or the DocumentSnapshot was nil.
            print("Document does not exist")
        }
    case .failure(let error):
        // A `City` value could not be initialized from the DocumentSnapshot.
        print("Error decoding city: (error)")
    }
}

Comments

[hoshi-takanori]

document の値を City 型に変換する際に、必要な属性が足りなかったり、型が合わなかったりする場合のエラーを Result で捕まえてるんだと思います。result 自体は Optional ではありませんが、document が nil の場合には result は .success(nil) になります。(これはいけてない気が…。というか、getDocument の結果を (document, error) ではなく Result で渡してほしいけど、そうなってないのは歴史的事情でしょうね。)

[shuntakahashi]

コメントありがとうございます。
import FirebaseFirestoreSwiftでライブラリをインポートすることで、Resultが使えて
SwiftのオブジェクトへFireStoreからデコードする際にエラーが発生するかもしれないので
Resultの関数の引数としてdocumentをラッピングしていると理解しました。

ご教授ありがとうございます。

[hoshi-takanori]

Result そのものは Swift 5 で導入された標準ライブラリの型なので、Firebase 以外でも使えます。
https://developer.apple.com/documentation/swift/result

[hameji001]

コメントのところで、英語で書いてありますよ。
一度、google翻訳など試されては？