プロトコル

CustomPlaygroundDisplayConvertible

プレイグラウンドのログ記録にカスタムの説明を提供する型。

iOS 8.0+ iPadOS 8.0+ Mac Catalyst 13.0+ macOS 10.10+

tvOS 9.0+ VisionOS 1.0+ WatchOS 2.0+

protocol CustomPlaygroundDisplayConvertible

概観

プレイグラウンドのログ記録では、少なくとも、あらゆる型の構造化された説明を生成できます。デフォルトの説明の代わりに、ログに記録する型のカスタム説明を提供する場合は、CustomPlaygroundDisplayConvertible プロトコルに準拠します。

プレイグラウンドのログ記録では、コアな型についてより豊富でより特化した説明が生成されます。たとえば、String の内容がログに記録され、NSColor や UIColor のコンポーネントもログに記録されます。現在のプレイグラウンドのログ記録実装では、少なくとも以下の型の特化した説明がログに記録されます。

String と NSString

Int, UInt およびその他の標準ライブラリの整数型

Float と Double

Bool

Date と NSDate

NSAttributedString

NSNumber

NSRange

URL と NSURL

CGPoint, CGSize と CGRect

NSColor, UIColor, CGColor と CIColor

NSImage, UIImage, CGImage と CIImage

NSBezierPath と UIBezierPath

NSView と UIView

プレイグラウンドのログ記録では、他の型の特殊な説明もサポートできる場合があります。

CustomPlaygroundDisplayConvertible プロトコルに準拠

カスタムの型に CustomPlaygroundDisplayConvertible への準拠を追加するには、playgroundDescription プロパティを実装します。実装が上記のいずれかの型のインスタンスを返す場合、その型の特殊な説明が使用されます。他の型を返す場合は、構造化された説明が生成されます。

型に値の意味がある場合、可能であれば、playgroundDescription は後続の変更の影響を受けないようにする必要があります。

型の playgroundDescription が CustomPlaygroundDisplayConvertible に準拠するインスタンスを返す場合、その型の playgroundDescription が使用され、以下同様に続きます。無限ループを防ぐために、プレイグラウンドのログ記録実装では、この種の連鎖に適切な制限を設けることができます。