Swift CustomStringConvertible用法及代碼示例

CustomStringConvertible

概述

符合 CustomStringConvertible 協議的類型可以提供自己的表示形式，以便在將實例轉換為字符串時使用。 String(describing:) 初始化程序是將any 類型的實例轉換為字符串的首選方法。如果傳遞的實例符合 CustomStringConvertible ，則 String(describing:) 初始化程序和 print(_:) 函數使用實例的自定義 description 屬性。

不鼓勵直接訪問類型的 description 屬性或使用 CustomStringConvertible 作為通用約束。

符合CustomStringConvertible 協議

通過定義 description 屬性，將 CustomStringConvertible 一致性添加到您的自定義類型。

例如，這個自定義 Point 結構使用標準庫提供的默認表示：

struct Point {
    let x: Int, y: Int
}


let p = Point(x: 21, y: 30)
print(p)
// Prints "Point(x: 21, y: 30)"

在實現description 屬性並聲明CustomStringConvertible 一致性之後，Point 類型提供了自己的自定義表示。

extension Point: CustomStringConvertible {
    var description: String {
        return "(\(x), \(y))"
    }
}


print(p)
// Prints "(21, 30)"