Skip to content

Improved Encoding/Decoding error descriptions #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 19, 2023
Merged

Improved Encoding/Decoding error descriptions #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions Sources/OpenAPIRuntime/Errors/CodingErrors.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,29 +18,43 @@ extension DecodingError: PrettyStringConvertible {
let output: String
switch self {
case .dataCorrupted(let context):
output = "dataCorrupted - \(context.debugDescription)"
output = "dataCorrupted - \(context.prettyDescription)"
case .keyNotFound(let key, let context):
output = "keyNotFound \(key) - \(context.debugDescription)"
output = "keyNotFound \(key) - \(context.prettyDescription)"
case .typeMismatch(let type, let context):
output = "typeMismatch \(type) - in \(context.debugDescription)"
output = "typeMismatch \(type) - \(context.prettyDescription)"
case .valueNotFound(let type, let context):
output = "valueNotFound \(type) - \(context.debugDescription)"
output = "valueNotFound \(type) - \(context.prettyDescription)"
@unknown default:
output = "unknown: \(localizedDescription)"
}
return "DecodingError: \(output)"
}
}

extension DecodingError.Context: PrettyStringConvertible {
var prettyDescription: String {
let path = codingPath.map(\.description).joined(separator: "/")
return "at \(path): \(debugDescription) (underlying error: \(underlyingError?.localizedDescription ?? "<nil>"))"
}
}

extension EncodingError: PrettyStringConvertible {
var prettyDescription: String {
let output: String
switch self {
case .invalidValue(let value, let context):
output = "invalidValue \(value) - \(context)"
output = "invalidValue \(value) - \(context.prettyDescription)"
@unknown default:
output = "unknown: \(localizedDescription)"
}
return "EncodingError: \(output)"
}
}

extension EncodingError.Context: PrettyStringConvertible {
var prettyDescription: String {
let path = codingPath.map(\.description).joined(separator: "/")
return "at \(path): \(debugDescription) (underlying error: \(underlyingError?.localizedDescription ?? "<nil>"))"
}
}