How to use reflection to inspect type data

Swift version: 5.1

Paul Hudson    @twostraws    May 28th 2019

Swift has a built-in Mirror struct that lets us query any kind of data in our code. It’s most commonly used to read through the list of properties that are available, but it’s also used in playgrounds to print out user-readable values inside types.

To get started, first create a custom type then an instance of that type:

struct Person {
    var name = "Taylor Swift"
    var age = 26
}

var taylor = Person()

You can now instantiate a Mirror object from taylor, like this:

var mirror = Mirror(reflecting: taylor)

That mirror isn’t a copy of taylor, a reflection of it – something you can inspect. For example, you can loop over all the properties inside taylor and print out their names and values like this:

for case let (label?, value) in mirror.children {
    print (label, value)
}

Available from iOS 8.0

Similar solutions…

• What’s the difference between @ObservedObject, @State, and @EnvironmentObject?
• How to configure Core Data to work with SwiftUI
• SwiftUI tips and tricks
• How to run code when your app is terminated
• How to decode JSON from your app bundle the easy way

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.