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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2022 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 {
// Set of constraints that describe the value held by a variable.
//
// These constraints include the allowed minimum or maximum value,
// the minimum or maximum lengths of a string value,
// the exact allowed values, and the default value assumed when one isn't
// explicitly specified.
/// The minimum value, which can be specified as an integer or floating point.
public struct Minimum: SingleValueMixin {
public static let mixinKey = "minimum"
public typealias ValueType = SymbolGraph.AnyNumber
public var value: ValueType
public init(_ value: ValueType) {
self.value = value
}
}
public var minimum : SymbolGraph.AnyNumber? {
(mixins[Minimum.mixinKey] as? Minimum)?.value
}
/// The maximum value, which can be specified as an integer or floating point.
public struct Maximum: SingleValueMixin {
public static let mixinKey = "maximum"
public typealias ValueType = SymbolGraph.AnyNumber
public var value: ValueType
public init(_ value: ValueType) {
self.value = value
}
}
public var maximum : SymbolGraph.AnyNumber? {
(mixins[Maximum.mixinKey] as? Maximum)?.value
}
/// The lower bound of allowed values, excluding the value itself, which can be specified as an integer or floating point.
public struct MinimumExclusive: SingleValueMixin {
public static let mixinKey = "minimumExclusive"
public typealias ValueType = SymbolGraph.AnyNumber
public var value: ValueType
public init(_ value: ValueType) {
self.value = value
}
}
public var minimumExclusive : SymbolGraph.AnyNumber? {
(mixins[MinimumExclusive.mixinKey] as? MinimumExclusive)?.value
}
/// The upper bound of allowed values, excluding the value itself, which can be specified as an integer or floating point.
public struct MaximumExclusive: SingleValueMixin {
public static let mixinKey = "maximumExclusive"
public typealias ValueType = SymbolGraph.AnyNumber
public var value: ValueType
public init(_ value: ValueType) {
self.value = value
}
}
public var maximumExclusive : SymbolGraph.AnyNumber? {
(mixins[MaximumExclusive.mixinKey] as? MaximumExclusive)?.value
}
/// The minimum length of a string.
public struct MinimumLength: SingleValueMixin {
public static let mixinKey = "minimumLength"
public typealias ValueType = Int
public var value: ValueType
public init(_ value: ValueType) {
self.value = value
}
}
public var minimumLength : Int? {
(mixins[MinimumLength.mixinKey] as? MinimumLength)?.value
}
/// The maximum length of a string.
public struct MaximumLength: SingleValueMixin {
public static let mixinKey = "maximumLength"
public typealias ValueType = Int
public var value: ValueType
public init(_ value: ValueType) {
self.value = value
}
}
public var maximumLength : Int? {
(mixins[MaximumLength.mixinKey] as? MaximumLength)?.value
}
/// The finite set of values allowed, which can be specified as strings, numbers, booleans, or a null, depending on context.
public struct AllowedValues: SingleValueMixin {
public static let mixinKey = "allowedValues"
public typealias ValueType = [SymbolGraph.AnyScalar]
public var value: ValueType
public init(_ value: ValueType) {
self.value = value
}
}
public var allowedValues : [SymbolGraph.AnyScalar]? {
(mixins[AllowedValues.mixinKey] as? AllowedValues)?.value
}
/// The default value, which can be specified as a string, number, boolean, or a null, depending on context.
public struct DefaultValue: SingleValueMixin {
public static let mixinKey = "default"
public typealias ValueType = SymbolGraph.AnyScalar
public var value: ValueType
public init(_ value: ValueType) {
self.value = value
}
// Need custom init(from:) to special case `null` value.
public init(from decoder: Decoder) throws {
let container = try decoder.singleValueContainer()
if container.decodeNil() {
self.init(.null)
return
}
self.init(try container.decode(ValueType.self))
}
}
public var defaultValue : SymbolGraph.AnyScalar? {
(mixins[DefaultValue.mixinKey] as? DefaultValue)?.value
}
/// A detailed description of the set of types allowed for a parameter or key.
///
/// Weakly-typed data structures, such as JSON, can allow a field to hold a value from a set of types,
/// rather than being of a singular fixed type.
/// For example, a time could be specified as an integer number of seconds from an epoch (eg, 1234)
/// or a time stamp string ("12:34pm"). A client can detect the different types and interpret them accordingly.
/// Whereas ``DeclarationFragments`` represents the declaration of the whole entity,
/// each ``TypeDetail`` member provides information, including the declaration, about the individual allowed types.
public struct TypeDetails: SingleValueMixin {
public static let mixinKey = "typeDetails"
public typealias ValueType = [TypeDetail]
public var value: ValueType
public init(_ value: ValueType) {
self.value = value
}
}
public var typeDetails : [TypeDetail]? {
(mixins[TypeDetails.mixinKey] as? TypeDetails)?.value
}
/// Detailed description of one of the types allowed for a weakly-typed parameter or key.
public struct TypeDetail: Codable {
/// The declaration of this individual type.
public var fragments: [DeclarationFragments.Fragment]?
/// The primitive type of this type, such as "string", "integer", or "dictionary".
public var baseType: String?
/// Whether the value for this type is actually an array of values.
public var arrayMode: Bool?
public init(fragments: [DeclarationFragments.Fragment]? = nil, baseType: String? = nil, arrayMode: Bool? = nil) {
self.fragments = fragments
self.baseType = baseType
self.arrayMode = arrayMode
}
}
}
|
