Skip to content

Let CodingKey inherit CustomStringConvertible for better debugging #10350

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 4 commits into from
Jul 20, 2017
Merged

Let CodingKey inherit CustomStringConvertible for better debugging #10350

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f4e8cbb
Let CodingKey inherit CustomStringConvertible for better debugging
inamiy Jun 17, 2017
33582e6
Improve CodingKey description
inamiy Jul 16, 2017
98ed5f9
Improve CodingKey description (add double-quote)
inamiy Jul 16, 2017
e017508
Simplify CodingKey description
inamiy Jul 17, 2017
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
15 changes: 14 additions & 1 deletion stdlib/public/core/Codable.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public typealias Codable = Encodable & Decodable
//===----------------------------------------------------------------------===//

/// A type that can be used as a key for encoding and decoding.
public protocol CodingKey {
public protocol CodingKey: CustomStringConvertible, CustomDebugStringConvertible {
/// The string to use in a named collection (e.g. a string-keyed dictionary).
var stringValue: String { get }

Expand All @@ -67,6 +67,19 @@ public protocol CodingKey {
init?(intValue: Int)
}

extension CodingKey {
/// A textual representation of this key.
public var description: String {
let intValue = self.intValue?.description ?? "nil"
return "\(type(of: self))(stringValue: \"\(stringValue)\", intValue: \(intValue))"
}

/// A textual representation of this key, suitable for debugging.
public var debugDescription: String {
return description
}
}

//===----------------------------------------------------------------------===//
// Encoder & Decoder
//===----------------------------------------------------------------------===//
Expand Down