SE-0194 introduced a new CaseIterable
protocol that automatically generates an array property of all cases in an enum.
Prior to Swift 4.2 this either took hacks, hand-coding, or Sourcery code generation to accomplish, but now all you need to do is make your enum conform to the CaseIterable
protocol. At compile time, Swift will automatically generate an allCases
property that is an array of all your enum’s cases, in the order you defined them.
For example, this creates an enum of pasta shapes and asks Swift to automatically generate an allCases
array for it:
enum Pasta: CaseIterable {
case cannelloni, fusilli, linguine, tagliatelle
}
You can then go ahead and use that property as a regular array – it will be a [Pasta]
given the code above, so we could print it like this:
for shape in Pasta.allCases {
print("I like eating \(shape).")
}
This automatic synthesis of allCases
will only take place for enums that do not use associated values. Adding those automatically wouldn’t make sense, however if you want you can add it yourself:
enum Car: CaseIterable {
static var allCases: [Car] {
return [.ford, .toyota, .jaguar, .bmw, .porsche(convertible: false), .porsche(convertible: true)]
}
case ford, toyota, jaguar, bmw
case porsche(convertible: Bool)
}
At this time, Swift is unable to synthesize the allCases
property if any of your enum cases are marked unavailable. So, if you need allCases
then you’ll need to add it yourself, like this:
enum Direction: CaseIterable {
static var allCases: [Direction] {
return [.north, .south, .east, .west]
}
case north, south, east, west
@available(*, unavailable)
case all
}
Important: You need to add CaseIterable
to the original declaration of your enum rather than an extension in order for the allCases
array to be synthesized. This means you can’t use extensions to retroactively make existing enums conform to the protocol.
SPONSORED Still waiting on your CI build? Speed it up ~3x with Blaze - change one line, pay less, keep your existing GitHub workflows. First 25 HWS readers to use code HACKING at checkout get 50% off the first year. Try it now for free!
Sponsor Hacking with Swift and reach the world's largest Swift community!
Download all Swift 4.2 changes as a playground Link to Swift 4.2 changes
Link copied to your pasteboard.