1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
import Foundation
extension SymbolGraph.Symbol.Swift {
/**
If the Symbol is from Swift, this mixin describes the extension context in which it was defined.
*/
public struct Extension: Mixin {
public static let mixinKey = "swiftExtension"
/**
The module whose type was extended.
> Note: This module maybe different than where the symbol was actually defined. For example, one can create a public extension on the Swift Standard Library's `String` type in a different module, so `extendedModule` would be `Swift`.
*/
public var extendedModule: String
/**
The ``SymbolGraph/Symbol/KindIdentifier`` of the symbol this
extension extends.
Usually, this will be either of ``SymbolGraph/Symbol/KindIdentifier/struct``,
``SymbolGraph/Symbol/KindIdentifier/class``, ``SymbolGraph/Symbol/KindIdentifier/enum``
or ``SymbolGraph/Symbol/KindIdentifier/protocol``.
*/
public var typeKind: SymbolGraph.Symbol.KindIdentifier?
/**
The generic constraints on the extension, if any.
*/
public var constraints: [GenericConstraint]
enum CodingKeys: String, CodingKey {
case extendedModule
case typeKind
case constraints
}
public init(extendedModule: String, typeKind: SymbolGraph.Symbol.KindIdentifier? = nil, constraints: [SymbolGraph.Symbol.Swift.GenericConstraint]) {
self.extendedModule = extendedModule
self.typeKind = typeKind
self.constraints = constraints
}
public init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
extendedModule = try container.decode(String.self, forKey: .extendedModule)
typeKind = try container.decodeIfPresent(SymbolGraph.Symbol.KindIdentifier.self, forKey: .typeKind)
constraints = try container.decodeIfPresent([GenericConstraint].self, forKey: .constraints) ?? []
}
public func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
try container.encode(extendedModule, forKey: .extendedModule)
try container.encodeIfPresent(typeKind, forKey: .typeKind)
if !constraints.isEmpty {
try container.encode(constraints, forKey: .constraints)
}
}
}
}
|
