Protocol
XMLChoiceCodingKey
public protocol XMLChoiceCodingKey: CodingKey
An empty marker protocol that can be used in place of CodingKey
. It must be used when
attempting to encode and decode union-type–like enums with associated values to and from XML
choice elements.
For example, say you have defined a type which can hold either an Int
or a String
:
enum IntOrString {
case int(Int)
case string(String)
}
Implementing the requirements for the Codable
protocol like this:
extension IntOrString: Codable {
enum CodingKeys: String, XMLChoiceCodingKey {
case int
case string
}
func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
switch self {
case let .int(value):
try container.encode(value, forKey: .int)
case let .string(value):
try container.encode(value, forKey: .string)
}
}
init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
do {
self = .int(try container.decode(Int.self, forKey: .int))
} catch {
self = .string(try container.decode(String.self, forKey: .string))
}
}
}
Retroactively conform the CodingKeys
enum to XMLChoiceCodingKey
when targeting XML
as your
encoded format.
extension IntOrString.CodingKeys: XMLChoiceCodingKey {}
Relationships
Conforms To
CodingKey