Swiftpack.co - pointfreeco/swift-case-paths as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by pointfreeco.
pointfreeco/swift-case-paths 0.14.0
🧰 Case paths bring the power and ergonomics of key paths to enums!
⭐️ 672
🕓 2 weeks ago
iOS macOS watchOS tvOS
.package(url: "https://github.com/pointfreeco/swift-case-paths.git", from: "0.14.0")

🧰 CasePaths

CI Slack

Case paths bring the power and ergonomics of key paths to enums!


Swift endows every struct and class property with a key path.

struct User {
  var id: Int
  var name: String

\User.id   // WritableKeyPath<User, Int>
\User.name // WritableKeyPath<User, String>

This is compiler-generated code that can be used to abstractly zoom in on part of a structure, inspect and even change it, while propagating these changes to the structure's whole. They unlock the ability to do many things, like key-value observing and reactive bindings, dynamic member lookup, and scoping changes to the SwiftUI environment.

Unfortunately, no such structure exists for enum cases!

enum Authentication {
  case authenticated(accessToken: String)
  case unauthenticated

\Authentication.authenticated // 🛑

And so it's impossible to write similar generic algorithms that can zoom in on a particular enum case.

Introducing: case paths

This library intends to bridge this gap by introducing what we call "case paths." Case paths can be constructed simply by prepending the enum type and case name with a forward slash:

import CasePaths

/Authentication.authenticated // CasePath<Authentication, String>

Case paths vs. key paths

While key paths package up the functionality of getting and setting a value on a root structure, case paths package up the functionality of extracting and embedding a value on a root enumeration.

user[keyPath: \User.id] = 42
user[keyPath: \User.id] // 42

let authentication = (/Authentication.authenticated).embed("cafebeef")
(/Authentication.authenticated).extract(from: authentication) // Optional("cafebeef")

Case path extraction can fail and return nil because the cases may not match up.

(/Authentication.authenticated).extract(from: .unauthenticated) // nil

Case paths, like key paths, compose. Where key paths use dot-syntax to dive deeper into a structure, case paths use a double-dot syntax:

// WritableKeyPath<HighScore, String>

/Result<Authentication, Error>..Authentication.authenticated
// CasePath<Result<Authentication, Error>, String>

Case paths, also like key paths, provide an "identity" path, which is useful for interacting with APIs that use key paths and case paths but you want to work with entire structure.

\User.self           // WritableKeyPath<User, User>
/Authentication.self // CasePath<Authentication, Authentication>

Key paths are created for every property, even computed ones, so what is the equivalent for case paths? Well, "computed" case paths can be created by providing custom embed and extract functions:

CasePath<Authentication, String>(
  embed: { decryptedToken in
    Authentication.authenticated(token: encrypt(decryptedToken))
  extract: { authentication in
      case let .authenticated(encryptedToken) = authentication,
      let decryptedToken = decrypt(token)
      else { return nil }
    return decryptedToken

Since Swift 5.2, key path expressions can be passed directly to methods like map. The same is true of case path expressions, which can be passed to methods like compactMap:


Ergonomic associated value access

CasePaths uses Swift reflection to automatically embed and extract associated values from any enum in a single, short expression. This helpful utility is made available as a public module function that can be used in your own libraries and apps:

(/Authentication.authenticated).extract(from: .authenticated("cafebeef"))
// Optional("cafebeef")


If you want to discuss this library or have a question about how to use it to solve a particular problem, there are a number of places you can discuss with fellow Point-Free enthusiasts:


The latest documentation for CasePaths' APIs is available here.

Other libraries

  • EnumKit is a protocol-oriented, reflection-based solution to ergonomic enum access and inspired the creation of this library.

Interested in learning more?

These concepts (and more) are explored thoroughly in Point-Free, a video series exploring functional programming and Swift hosted by Brandon Williams and Stephen Celis.

The design of this library was explored in the following Point-Free episodes:

video poster image


All modules are released under the MIT license. See LICENSE for details.


Stars: 672
Last commit: Yesterday
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Release Notes

2 weeks ago

What's Changed

  • Added: A new @_spi(Reflection) API for projecting into any enum value (https://github.com/pointfreeco/swift-case-paths/pull/103).
  • Fixed: CasePath's reflection mechanism for extracting values has been rewritten to use the aforementioned API, fixing existing bugs with extraction around compound associated values containing existentials. If you encounter any regressions with this upgrade, please let us know!

Full Changelog: https://github.com/pointfreeco/swift-case-paths/compare/0.13.0...0.14.0

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics