Skip to content

Commit bcba1a4

Browse files
committed
refactor: rename Serializing to Serializable and update README
1 parent 67083e5 commit bcba1a4

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,13 +91,13 @@ let valid3 = try EmailAddress("\"user name\"@example.com")
9191
// Invalid addresses throw errors
9292
do {
9393
let invalid = try EmailAddress("no-at-sign")
94-
} catch EmailAddress.ValidationError.missingAtSign {
94+
} catch EmailAddress.Error.missingAtSign {
9595
print("Missing @ symbol")
9696
}
9797

9898
do {
9999
let tooLong = try EmailAddress("verylonglocalpartthatexceedssixtyfourcharactersshouldnotbeallowed@example.com")
100-
} catch EmailAddress.ValidationError.localPartTooLong(let length) {
100+
} catch EmailAddress.Error.localPartTooLong(let length) {
101101
print("Local part too long: \(length) characters")
102102
}
103103
```
@@ -148,7 +148,7 @@ let domain = try Domain("mail.example.com")
148148
### Validation Errors
149149

150150
```swift
151-
public enum ValidationError: Error {
151+
public enum Error: Swift.Error {
152152
case missingAtSign
153153
case invalidDotAtom
154154
case invalidQuotedString

Sources/RFC 5321/RFC_5321.EmailAddress.Error.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ extension RFC_5321.EmailAddress {
3434
case invalidLocalPart(_ error: LocalPart.Error)
3535

3636
/// Domain validation failed
37-
case invalidDomain(_ error: Domain.ValidationError)
37+
case invalidDomain(_ error: RFC_1123.Domain.Error)
3838
}
3939
}
4040

Sources/RFC 5321/RFC_5321.EmailAddress.swift

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,12 @@ extension RFC_5321 {
2828
/// Initialize with validated components
2929
///
3030
/// This is the canonical initializer. Components are already validated.
31-
public init(displayName: (some StringProtocol)? = nil, localPart: LocalPart, domain: RFC_1123.Domain) throws(Error) {
32-
self.displayName = displayName.map { String($0).trimming(.ascii.whitespaces) }
31+
public init(
32+
displayName: String? = nil,
33+
localPart: LocalPart,
34+
domain: RFC_1123.Domain
35+
) throws(Error) {
36+
self.displayName = displayName?.trimming(.ascii.whitespaces)
3337
self.localPart = localPart
3438
self.domain = domain
3539

@@ -89,10 +93,8 @@ extension RFC_5321.EmailAddress {
8993
let domain: RFC_1123.Domain
9094
do {
9195
domain = try RFC_1123.Domain(domainString)
92-
} catch let domainError as Domain.ValidationError {
96+
} catch let domainError {
9397
throw Error.invalidDomain(domainError)
94-
} catch {
95-
fatalError("Unexpected error type from RFC_1123.Domain.init: \(error)")
9698
}
9799

98100
try self.init(
@@ -120,14 +122,12 @@ extension RFC_5321.EmailAddress {
120122
let domain: RFC_1123.Domain
121123
do {
122124
domain = try RFC_1123.Domain(domainString)
123-
} catch let domainError as Domain.ValidationError {
125+
} catch let domainError {
124126
throw Error.invalidDomain(domainError)
125-
} catch {
126-
fatalError("Unexpected error type from RFC_1123.Domain.init: \(error)")
127127
}
128128

129129
try self.init(
130-
displayName: nil as String?,
130+
displayName: nil,
131131
localPart: localPart,
132132
domain: domain
133133
)
@@ -187,5 +187,5 @@ extension RFC_5321.EmailAddress: Codable {
187187

188188
extension RFC_5321.EmailAddress: RawRepresentable {
189189
public var rawValue: String { String(self) }
190-
public init?(rawValue: some StringProtocol) { try? self.init(rawValue) }
190+
public init?(rawValue: String) { try? self.init(rawValue) }
191191
}

Sources/RFC 5321/exports.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
// Created by Coen ten Thije Boonkkamp on 21/11/2025.
66
//
77

8-
@_exported import struct RFC_1123.Domain
8+
@_exported import RFC_1123

0 commit comments

Comments
 (0)