How to use reflection to inspect type data

Swift version: 5.6

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)
}

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.

Learn more

Sponsor Hacking with Swift and reach the world's largest Swift community!

Available from iOS 8.0

Similar solutions…

• All SwiftUI property wrappers explained and compared
• What’s the difference between @ObservedObject, @State, and @EnvironmentObject?
• SwiftUI tips and tricks
• How to download JSON from the internet and decode it into any Codable type
• How to call an async function using async let

About the Swift Knowledge Base

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