CustomPlaygroundDisplayConvertible

protocol CustomPlaygroundDisplayConvertible

Overview 概要

Playground logging can generate, at a minimum, a structured description of any type. If you want to provide a custom description of your type to be logged in place of the default description, conform to the CustomPlaygroundDisplayConvertible protocol. プレイグラウンドログは、最低でも、あらゆる型の構造化された記述を生成できます。あなたの型のあつらえの記述を提供して省略時の記述の代わりに記録されるようにしたいならば、CustomPlaygroundDisplayConvertibleプロトコルに準拠してください。

Playground logging generates a richer, more specialized description of core types. For example, the contents of a String are logged, as are the components of an NSColor or UIColor. The current playground logging implementation logs specialized descriptions of at least the following types: プレイグラウンドログは、中心的な型のより豊かな、さらに特殊化された記述を生成します。例えば、あるStringのそれら内容が記録されます、あるNSColorまたはUIColorの構成要素それらのように。現在のプレイグラウンドログ実装は、少なくとも以下の型の特殊化された記述を記録します：

• String and NSString StringおよびNSString

• Int, UInt, and the other standard library integer types Int、UInt、そして他の標準ライブラリの整数型

• Float and Double FloatおよびDouble

• Bool

• Date and NSDate DateおよびNSDate

• NSAttributedString

• NSNumber

• NSRange

• URL and NSURL URLおよびNSURL

• CGPoint, CGSize, and CGRect CGPoint、CGSize、およびCGRect

• NSColor, UIColor, CGColor, and CIColor NSColor、UIColor、CGColor、およびCIColor

• NSImage, UIImage, CGImage, and CIImage NSImage、UIImage、CGImage、およびCIImage

• NSBezierPath and UIBezierPath NSBezierPathおよびUIBezierPath

• NSView and UIView NSViewおよびUIView

Playground logging may also be able to support specialized descriptions of other types. プレイグラウンドログはまた、他の型の特殊化された記述のサポートが可能です。

Conforming to the CustomPlaygroundDisplayConvertible Protocol CustomPlaygroundDisplayConvertibleプロトコルに準拠する

To add CustomPlaygroundDisplayConvertible conformance to your custom type, implement the playgroundDescription property. If your implementation returns an instance of one of the types above, that type’s specialized description is used. If you return any other type, a structured description is generated. CustomPlaygroundDisplayConvertible準拠をあなたのあつらえの型に加えるには、playgroundDescriptionプロパティを実装してください。あなたの実装が上の型の１つのインスタンスを返すならば、その型のもつ特殊化された記述が使われます。あなたが何か他の型を返すならば、構造化された記述が生成されます。

If your type has value semantics, the playgroundDescription should be unaffected by subsequent mutations, if possible. あなたの型が値意味論を持つならば、playgroundDescriptionはその後の変化によって影響を受けないべきです、できれば。

If your type’s playgroundDescription returns an instance which itself conforms to CustomPlaygroundDisplayConvertible, then that type’s playgroundDescription will be used, and so on. To prevent infinite loops, playground logging implementations can place a reasonable limit on this kind of chaining. あなたの型のもつplaygroundDescriptionがそれ自体がCustomPlaygroundDisplayConvertibleに準拠するインスタンスを返すならば、そのときその型のもつplaygroundDescriptionが使われます、などなど。無限ループを防ぐには、プレイグラウンドログ実装はこの種の連鎖に関して妥当な制限を置くことができます。