Mastering KeyPaths: Swift's Type-Safe Property Manipulation

A portrait painting style image of a pirate holding an iPhone.

by The Captain

May 5, 2024

Working with KeyPaths in Swift

KeyPaths in Swift allow you to reference and manipulate properties of a type in a type-safe way. They are particularly useful when you want to refer to properties of a type without needing to actually access them. KeyPaths are represented as a type that encapsulates information about a specific property of a given type.

To create a KeyPath, you can use the \ (backslash) operator followed by the name of the property you want to reference. Here's an example:

struct Person {
    let name: String
    let age: Int

let nameKeyPath = \
let ageKeyPath = \Person.age

let john = Person(name: "John", age: 30)

let johnsName = john[keyPath: nameKeyPath]
let johnsAge = john[keyPath: ageKeyPath]

print("John's name is \(johnsName) and he is \(johnsAge) years old.")}

Using KeyPaths in Functional Programming

KeyPaths can also be used in functional programming to manipulate properties of a type. For example, you can use KeyPaths with higher-order functions like map, filter, and reduce to transform or filter collections of objects based on certain properties.

let people = [Person(name: "Alice", age: 25), Person(name: "Bob", age: 35), Person(name: "Carol", age: 40)]

let names = { $0[keyPath: nameKeyPath] }

let adults = people.filter { $0[keyPath: ageKeyPath] > 30 }


KeyPaths in Swift provide a powerful way to work with properties in a type-safe manner. They allow you to reference and manipulate properties without needing to access them directly, making your code more readable and maintainable. By understanding how to create and use KeyPaths effectively, you can take advantage of this feature to streamline your code and improve its overall robustness.