What is an enum's hash value in Swift?

In Swift, the hash value of an enum is an integer that uniquely identifies each case of the enum. Hash values are primarily used for comparing enum cases quickly, especially when storing enums in sets or using them as keys in dictionaries.

When you conform an enum to the Hashable protocol, Swift automatically synthesizes the hashValue property if the enum doesn't have associated values, or if its associated values are also Hashable.

Here’s a breakdown of what the hash value represents and how it’s used:

1. Purpose:

- To provide a unique integer representation for each enum case.

- Allows for efficient comparisons and lookups.

2. Automatic Synthesis:

- For enums without associated values, Swift automatically assigns different integers to each case.

- For enums with associated values, the hash value is calculated based on the hash values of the associated values.

3. Usage:

- Used internally by Swift to store enum values in hash-based collections like Set and Dictionary.

- Enables quick equality checks.

4. Example:

Consider the following example enum:

enum Color: Hashable {
  case red
  case green
  case blue
}

let myColor = Color.red
print(myColor.hashValue) // Output might be 0, 1, or 2 (implementation detail)

Here, the hashValue for each case (red, green, blue) will be a different integer. The specific values are implementation details and can change between Swift versions, but they will be consistent within the same program execution.

5. Enums with Associated Values:

For enums with associated values, the hashValue is computed based on the associated values. Ensure the associated types are also Hashable.

enum Result<Success, Failure: Error>: Hashable {
  case success(Success)
  case failure(Failure)
}

In this generic enum, Success must also conform to Hashable for the enum to be Hashable.

6. Manual Implementation (Rare):

In rare cases, you might need to provide a custom implementation for hashValue if the synthesized implementation is not sufficient or correct for your specific use case.

In summary, an enum's hash value in Swift is an integer representation that allows for efficient comparisons and storage in hash-based collections. Swift automatically synthesizes this value when possible, making it easy to use enums in scenarios requiring hashing.

Learn more about this