Make AppleMapsKitError Equatable

Sources/AppleMapsKit/AppleMapsKitError.swift

@@ -1,7 +1,8 @@
 /// AppleMapsKit error type.
-public struct AppleMapsKitError: Error, Sendable {
-    public struct ErrorType: Sendable, Hashable, CustomStringConvertible {
-        enum Base: String, Sendable {
+public struct AppleMapsKitError: Error, Sendable, Equatable {
+    /// The type of the errors that can be thrown by AppleMapsKit.
+    public struct ErrorType: Sendable, Hashable, CustomStringConvertible, Equatable {
+        enum Base: String, Sendable, Equatable {
             case noPlacesFound
             case invalidSearchResultType
         }
@@ -11,36 +12,52 @@ public struct AppleMapsKitError: Error, Sendable {
         private init(_ base: Base) {
             self.base = base
         }
-
+
+        /// No places were found for the given query.
         public static let noPlacesFound = Self(.noPlacesFound)
+        /// The search result type is invalid.
         public static let invalidSearchResultType = Self(.invalidSearchResultType)
 
+        /// A textual representation of this error.
         public var description: String {
             self.base.rawValue
         }
     }
 
-    private struct Backing: Sendable {
+    private struct Backing: Sendable, Equatable {
         fileprivate let errorType: ErrorType
 
         init(errorType: ErrorType) {
             self.errorType = errorType
         }
+
+        static func == (lhs: AppleMapsKitError.Backing, rhs: AppleMapsKitError.Backing) -> Bool {
+            lhs.errorType == rhs.errorType
+        }
     }
 
     private var backing: Backing
 
+    /// The type of this error.
     public var errorType: ErrorType { backing.errorType }
 
     private init(errorType: ErrorType) {
         self.backing = .init(errorType: errorType)
     }
 
+    /// No places were found for the given query.
     public static let noPlacesFound = Self(errorType: .noPlacesFound)
+
+    /// The search result type is invalid.
     public static let invalidSearchResultType = Self(errorType: .invalidSearchResultType)
+
+    public static func == (lhs: AppleMapsKitError, rhs: AppleMapsKitError) -> Bool {
+        lhs.backing == rhs.backing
+    }
 }
 
 extension AppleMapsKitError: CustomStringConvertible {
+    /// A textual representation of this error.
     public var description: String {
         "AppleMapsKitError(errorType: \(self.errorType))"
     }

Tests/AppleMapsKitTests/AppleMapsKitTests.swift

@@ -91,14 +91,11 @@ struct AppleMapsKitTests {
     }
 
     @Test("Search with invalid Result Type") func searchWithInvalidResultType() async throws {
-        await #expect {
+        await #expect(throws: AppleMapsKitError.invalidSearchResultType) {
             try await client.search(
                 for: "eiffel tower",
                 resultTypeFilter: [.pointOfInterest, .physicalFeature, .poi, .address, .query]
             )
-        } throws: { error in
-            guard let error = error as? AppleMapsKitError else { return false }
-            return error.errorType.base == .invalidSearchResultType
         }
     }