How to create a custom debug description
Swift version: 5.6
Swift lets you print all types of data, but some data is more useful than others thanks to the CustomDebugStringConvertible protocol. If you write a type conforming to that protocol, you must include a debugDescription string property that describes how instances of this type should be represented while debugging.
To test this out, we’re going to create a Player struct that stores a player’s name. When we try to debug an instance of this struct – i.e., print it out, or hover over it in the debugger – we just want the player’s name to come back, for easier debugging.
Try adding this struct to a playground:
struct Player: CustomDebugStringConvertible {
var name: String = "@twostraws"
var debugDescription: String {
return name
}
}You can now create instances of that struct and print them out to see the player name:
let player = Player()
print(player)
SPONSORED In-app subscriptions are a pain to implement, hard to test, and full of edge cases. RevenueCat makes it straightforward and reliable so you can get back to building your app. Oh, and it's free if your app makes less than $10k/mo.
Sponsor Hacking with Swift and reach the world's largest Swift community!
Available from iOS 8.0 – learn more in my book Pro Swift
Similar solutions…
- How to create Quick Look debug previews for your custom types
- How to print debug text in Swift
- How to debug physics in a SpriteKit scene using showsPhysics
- How to debug view layouts in Xcode
- How to test localization by setting a debug locale and double length pseudolanguage
About the Swift Knowledge Base
This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.
