= [:]
21 | private var iteratorCount = 0
22 |
23 | /// `OrderedDictionary` constructor.
24 | public init() {}
25 |
26 | /// Read only property that provides the number of elements in the `OrderedDictionary`.
27 | public var count: Int {
28 | get {
29 | return self.keys.count
30 | }
31 | }
32 |
33 | /// Provides a way to add and remove elements from the
34 | /// `OrderedDictionary`, just like any other `Dictionary`.
35 | ///
36 | /// Setting an element to nil will remove it from the `OrderedDictionary`.
37 | public subscript(key: K) -> V? {
38 | get {
39 | return self.values[key]
40 | }
41 | set(value) {
42 | if let new = value {
43 | let old = self.values.updateValue(new, forKey: key)
44 | if old == nil {
45 | self.keys.append(key)
46 | }
47 | self.iteratorCount = self.keys.count
48 | return
49 | }
50 | self.values.removeValue(forKey: key)
51 | self.keys = self.keys.filter {$0 != key}
52 | self.iteratorCount = self.keys.count
53 | return
54 | }
55 | }
56 |
57 | /// Return the element value at the numeric index specified.
58 | public subscript(index: Int) -> V? {
59 | if self.keys.indices.contains(index) {
60 | let key = self.keys[index]
61 | return self.values[key]
62 | }
63 | return nil
64 | }
65 |
66 | /// Read only property that provides a String containing the key:value pairs in the `OrderedDictionary`.
67 | public var description: String {
68 | var result = ""
69 | for (k, v) in self {
70 | result += "\(k): \(v)\n"
71 | }
72 | return result
73 | }
74 |
75 | }
76 |
77 | extension OrderedDictionary: Sequence, IteratorProtocol {
78 | /// Method to allow iteration over the contents of the
79 | /// `OrderedDictionary`. This method ensures that items are read in the same
80 | /// sequence as they were added.
81 | public mutating func next() -> (K, V)? {
82 | if self.iteratorCount == 0 {
83 | return nil
84 | } else {
85 | defer { self.iteratorCount -= 1 }
86 | let theKey = self.keys[self.keys.count - self.iteratorCount]
87 | let theValue = self.values[theKey]
88 | if let unwrappedValue = theValue {
89 | return(theKey, unwrappedValue)
90 | }
91 | return nil
92 | }
93 | }
94 | }
95 |
--------------------------------------------------------------------------------
/docs/css/highlight.css:
--------------------------------------------------------------------------------
1 | /* Credit to https://gist.github.com/wataru420/2048287 */
2 | .highlight {
3 | /* Comment */
4 | /* Error */
5 | /* Keyword */
6 | /* Operator */
7 | /* Comment.Multiline */
8 | /* Comment.Preproc */
9 | /* Comment.Single */
10 | /* Comment.Special */
11 | /* Generic.Deleted */
12 | /* Generic.Deleted.Specific */
13 | /* Generic.Emph */
14 | /* Generic.Error */
15 | /* Generic.Heading */
16 | /* Generic.Inserted */
17 | /* Generic.Inserted.Specific */
18 | /* Generic.Output */
19 | /* Generic.Prompt */
20 | /* Generic.Strong */
21 | /* Generic.Subheading */
22 | /* Generic.Traceback */
23 | /* Keyword.Constant */
24 | /* Keyword.Declaration */
25 | /* Keyword.Pseudo */
26 | /* Keyword.Reserved */
27 | /* Keyword.Type */
28 | /* Literal.Number */
29 | /* Literal.String */
30 | /* Name.Attribute */
31 | /* Name.Builtin */
32 | /* Name.Class */
33 | /* Name.Constant */
34 | /* Name.Entity */
35 | /* Name.Exception */
36 | /* Name.Function */
37 | /* Name.Namespace */
38 | /* Name.Tag */
39 | /* Name.Variable */
40 | /* Operator.Word */
41 | /* Text.Whitespace */
42 | /* Literal.Number.Float */
43 | /* Literal.Number.Hex */
44 | /* Literal.Number.Integer */
45 | /* Literal.Number.Oct */
46 | /* Literal.String.Backtick */
47 | /* Literal.String.Char */
48 | /* Literal.String.Doc */
49 | /* Literal.String.Double */
50 | /* Literal.String.Escape */
51 | /* Literal.String.Heredoc */
52 | /* Literal.String.Interpol */
53 | /* Literal.String.Other */
54 | /* Literal.String.Regex */
55 | /* Literal.String.Single */
56 | /* Literal.String.Symbol */
57 | /* Name.Builtin.Pseudo */
58 | /* Name.Variable.Class */
59 | /* Name.Variable.Global */
60 | /* Name.Variable.Instance */
61 | /* Literal.Number.Integer.Long */ }
62 | .highlight .c {
63 | color: #999988;
64 | font-style: italic; }
65 | .highlight .err {
66 | color: #a61717;
67 | background-color: #e3d2d2; }
68 | .highlight .k {
69 | color: #000000;
70 | font-weight: bold; }
71 | .highlight .o {
72 | color: #000000;
73 | font-weight: bold; }
74 | .highlight .cm {
75 | color: #999988;
76 | font-style: italic; }
77 | .highlight .cp {
78 | color: #999999;
79 | font-weight: bold; }
80 | .highlight .c1 {
81 | color: #999988;
82 | font-style: italic; }
83 | .highlight .cs {
84 | color: #999999;
85 | font-weight: bold;
86 | font-style: italic; }
87 | .highlight .gd {
88 | color: #000000;
89 | background-color: #ffdddd; }
90 | .highlight .gd .x {
91 | color: #000000;
92 | background-color: #ffaaaa; }
93 | .highlight .ge {
94 | color: #000000;
95 | font-style: italic; }
96 | .highlight .gr {
97 | color: #aa0000; }
98 | .highlight .gh {
99 | color: #999999; }
100 | .highlight .gi {
101 | color: #000000;
102 | background-color: #ddffdd; }
103 | .highlight .gi .x {
104 | color: #000000;
105 | background-color: #aaffaa; }
106 | .highlight .go {
107 | color: #888888; }
108 | .highlight .gp {
109 | color: #555555; }
110 | .highlight .gs {
111 | font-weight: bold; }
112 | .highlight .gu {
113 | color: #aaaaaa; }
114 | .highlight .gt {
115 | color: #aa0000; }
116 | .highlight .kc {
117 | color: #000000;
118 | font-weight: bold; }
119 | .highlight .kd {
120 | color: #000000;
121 | font-weight: bold; }
122 | .highlight .kp {
123 | color: #000000;
124 | font-weight: bold; }
125 | .highlight .kr {
126 | color: #000000;
127 | font-weight: bold; }
128 | .highlight .kt {
129 | color: #445588; }
130 | .highlight .m {
131 | color: #009999; }
132 | .highlight .s {
133 | color: #d14; }
134 | .highlight .na {
135 | color: #008080; }
136 | .highlight .nb {
137 | color: #0086B3; }
138 | .highlight .nc {
139 | color: #445588;
140 | font-weight: bold; }
141 | .highlight .no {
142 | color: #008080; }
143 | .highlight .ni {
144 | color: #800080; }
145 | .highlight .ne {
146 | color: #990000;
147 | font-weight: bold; }
148 | .highlight .nf {
149 | color: #990000; }
150 | .highlight .nn {
151 | color: #555555; }
152 | .highlight .nt {
153 | color: #000080; }
154 | .highlight .nv {
155 | color: #008080; }
156 | .highlight .ow {
157 | color: #000000;
158 | font-weight: bold; }
159 | .highlight .w {
160 | color: #bbbbbb; }
161 | .highlight .mf {
162 | color: #009999; }
163 | .highlight .mh {
164 | color: #009999; }
165 | .highlight .mi {
166 | color: #009999; }
167 | .highlight .mo {
168 | color: #009999; }
169 | .highlight .sb {
170 | color: #d14; }
171 | .highlight .sc {
172 | color: #d14; }
173 | .highlight .sd {
174 | color: #d14; }
175 | .highlight .s2 {
176 | color: #d14; }
177 | .highlight .se {
178 | color: #d14; }
179 | .highlight .sh {
180 | color: #d14; }
181 | .highlight .si {
182 | color: #d14; }
183 | .highlight .sx {
184 | color: #d14; }
185 | .highlight .sr {
186 | color: #009926; }
187 | .highlight .s1 {
188 | color: #d14; }
189 | .highlight .ss {
190 | color: #990073; }
191 | .highlight .bp {
192 | color: #999999; }
193 | .highlight .vc {
194 | color: #008080; }
195 | .highlight .vg {
196 | color: #008080; }
197 | .highlight .vi {
198 | color: #008080; }
199 | .highlight .il {
200 | color: #009999; }
201 |
--------------------------------------------------------------------------------
/docs/docsets/TypeDecoder.docset/Contents/Resources/Documents/css/highlight.css:
--------------------------------------------------------------------------------
1 | /* Credit to https://gist.github.com/wataru420/2048287 */
2 | .highlight {
3 | /* Comment */
4 | /* Error */
5 | /* Keyword */
6 | /* Operator */
7 | /* Comment.Multiline */
8 | /* Comment.Preproc */
9 | /* Comment.Single */
10 | /* Comment.Special */
11 | /* Generic.Deleted */
12 | /* Generic.Deleted.Specific */
13 | /* Generic.Emph */
14 | /* Generic.Error */
15 | /* Generic.Heading */
16 | /* Generic.Inserted */
17 | /* Generic.Inserted.Specific */
18 | /* Generic.Output */
19 | /* Generic.Prompt */
20 | /* Generic.Strong */
21 | /* Generic.Subheading */
22 | /* Generic.Traceback */
23 | /* Keyword.Constant */
24 | /* Keyword.Declaration */
25 | /* Keyword.Pseudo */
26 | /* Keyword.Reserved */
27 | /* Keyword.Type */
28 | /* Literal.Number */
29 | /* Literal.String */
30 | /* Name.Attribute */
31 | /* Name.Builtin */
32 | /* Name.Class */
33 | /* Name.Constant */
34 | /* Name.Entity */
35 | /* Name.Exception */
36 | /* Name.Function */
37 | /* Name.Namespace */
38 | /* Name.Tag */
39 | /* Name.Variable */
40 | /* Operator.Word */
41 | /* Text.Whitespace */
42 | /* Literal.Number.Float */
43 | /* Literal.Number.Hex */
44 | /* Literal.Number.Integer */
45 | /* Literal.Number.Oct */
46 | /* Literal.String.Backtick */
47 | /* Literal.String.Char */
48 | /* Literal.String.Doc */
49 | /* Literal.String.Double */
50 | /* Literal.String.Escape */
51 | /* Literal.String.Heredoc */
52 | /* Literal.String.Interpol */
53 | /* Literal.String.Other */
54 | /* Literal.String.Regex */
55 | /* Literal.String.Single */
56 | /* Literal.String.Symbol */
57 | /* Name.Builtin.Pseudo */
58 | /* Name.Variable.Class */
59 | /* Name.Variable.Global */
60 | /* Name.Variable.Instance */
61 | /* Literal.Number.Integer.Long */ }
62 | .highlight .c {
63 | color: #999988;
64 | font-style: italic; }
65 | .highlight .err {
66 | color: #a61717;
67 | background-color: #e3d2d2; }
68 | .highlight .k {
69 | color: #000000;
70 | font-weight: bold; }
71 | .highlight .o {
72 | color: #000000;
73 | font-weight: bold; }
74 | .highlight .cm {
75 | color: #999988;
76 | font-style: italic; }
77 | .highlight .cp {
78 | color: #999999;
79 | font-weight: bold; }
80 | .highlight .c1 {
81 | color: #999988;
82 | font-style: italic; }
83 | .highlight .cs {
84 | color: #999999;
85 | font-weight: bold;
86 | font-style: italic; }
87 | .highlight .gd {
88 | color: #000000;
89 | background-color: #ffdddd; }
90 | .highlight .gd .x {
91 | color: #000000;
92 | background-color: #ffaaaa; }
93 | .highlight .ge {
94 | color: #000000;
95 | font-style: italic; }
96 | .highlight .gr {
97 | color: #aa0000; }
98 | .highlight .gh {
99 | color: #999999; }
100 | .highlight .gi {
101 | color: #000000;
102 | background-color: #ddffdd; }
103 | .highlight .gi .x {
104 | color: #000000;
105 | background-color: #aaffaa; }
106 | .highlight .go {
107 | color: #888888; }
108 | .highlight .gp {
109 | color: #555555; }
110 | .highlight .gs {
111 | font-weight: bold; }
112 | .highlight .gu {
113 | color: #aaaaaa; }
114 | .highlight .gt {
115 | color: #aa0000; }
116 | .highlight .kc {
117 | color: #000000;
118 | font-weight: bold; }
119 | .highlight .kd {
120 | color: #000000;
121 | font-weight: bold; }
122 | .highlight .kp {
123 | color: #000000;
124 | font-weight: bold; }
125 | .highlight .kr {
126 | color: #000000;
127 | font-weight: bold; }
128 | .highlight .kt {
129 | color: #445588; }
130 | .highlight .m {
131 | color: #009999; }
132 | .highlight .s {
133 | color: #d14; }
134 | .highlight .na {
135 | color: #008080; }
136 | .highlight .nb {
137 | color: #0086B3; }
138 | .highlight .nc {
139 | color: #445588;
140 | font-weight: bold; }
141 | .highlight .no {
142 | color: #008080; }
143 | .highlight .ni {
144 | color: #800080; }
145 | .highlight .ne {
146 | color: #990000;
147 | font-weight: bold; }
148 | .highlight .nf {
149 | color: #990000; }
150 | .highlight .nn {
151 | color: #555555; }
152 | .highlight .nt {
153 | color: #000080; }
154 | .highlight .nv {
155 | color: #008080; }
156 | .highlight .ow {
157 | color: #000000;
158 | font-weight: bold; }
159 | .highlight .w {
160 | color: #bbbbbb; }
161 | .highlight .mf {
162 | color: #009999; }
163 | .highlight .mh {
164 | color: #009999; }
165 | .highlight .mi {
166 | color: #009999; }
167 | .highlight .mo {
168 | color: #009999; }
169 | .highlight .sb {
170 | color: #d14; }
171 | .highlight .sc {
172 | color: #d14; }
173 | .highlight .sd {
174 | color: #d14; }
175 | .highlight .s2 {
176 | color: #d14; }
177 | .highlight .se {
178 | color: #d14; }
179 | .highlight .sh {
180 | color: #d14; }
181 | .highlight .si {
182 | color: #d14; }
183 | .highlight .sx {
184 | color: #d14; }
185 | .highlight .sr {
186 | color: #009926; }
187 | .highlight .s1 {
188 | color: #d14; }
189 | .highlight .ss {
190 | color: #990073; }
191 | .highlight .bp {
192 | color: #999999; }
193 | .highlight .vc {
194 | color: #008080; }
195 | .highlight .vg {
196 | color: #008080; }
197 | .highlight .vi {
198 | color: #008080; }
199 | .highlight .il {
200 | color: #009999; }
201 |
--------------------------------------------------------------------------------
/docs/search.json:
--------------------------------------------------------------------------------
1 | {"Structs/TypeDecoder.html#/s:11TypeDecoderAAV6decodeyAA0A4InfoOSe_pXpKFZ":{"name":"decode(_:)","abstract":"Returns a TypeInfo
","parent_name":"TypeDecoder"},"Structs/TypeDecodingError.html#/s:11TypeDecoder0A13DecodingErrorV7contexts0cD0O7ContextVvp":{"name":"context","abstract":"A description of the error and the underlying error, which is of type DecodingError.
","parent_name":"TypeDecodingError"},"Structs/OrderedDictionary.html#/s:11TypeDecoder17OrderedDictionaryVACyxq_Gycfc":{"name":"init()","abstract":"OrderedDictionary constructor.
","parent_name":"OrderedDictionary"},"Structs/OrderedDictionary.html#/s:11TypeDecoder17OrderedDictionaryV5countSivp":{"name":"count","abstract":"Read only property that provides the number of elements in the OrderedDictionary.
","parent_name":"OrderedDictionary"},"Structs/OrderedDictionary.html#/s:11TypeDecoder17OrderedDictionaryVyq_Sgxcip":{"name":"subscript(_:)","abstract":"Provides a way to add and remove elements from the","parent_name":"OrderedDictionary"},"Structs/OrderedDictionary.html#/s:11TypeDecoder17OrderedDictionaryVyq_SgSicip":{"name":"subscript(_:)","abstract":"
Return the element value at the numeric index specified.
","parent_name":"OrderedDictionary"},"Structs/OrderedDictionary.html#/s:11TypeDecoder17OrderedDictionaryV11descriptionSSvp":{"name":"description","abstract":"Read only property that provides a String containing the key:value pairs in the OrderedDictionary.
","parent_name":"OrderedDictionary"},"Structs/OrderedDictionary.html#/s:11TypeDecoder17OrderedDictionaryV4nextx_q_tSgyF":{"name":"next()","abstract":"Method to allow iteration over the contents of the","parent_name":"OrderedDictionary"},"Structs/OrderedDictionary.html":{"name":"OrderedDictionary"},"Structs/TypeDecodingError.html":{"name":"TypeDecodingError","abstract":"
An Error type indicating a problem during decoding by the TypeDecoder
"},"Structs/TypeDecoder.html":{"name":"TypeDecoder","abstract":"TypeDecoder allows you to decode a Swift type by using TypeDecoder.decode() and passing the type to"},"Protocols/ValidSingleCodingValueProvider.html#/s:11TypeDecoder30ValidSingleCodingValueProviderP05valideF0ypSgyFZ":{"name":"validCodingValue()","abstract":"
Returns a valid encoded representation of the conforming type.
","parent_name":"ValidSingleCodingValueProvider"},"Protocols/ValidKeyedCodingValueProvider.html#/s:11TypeDecoder29ValidKeyedCodingValueProviderP05valideF06forKeyypSgs0eJ0_p_tFZ":{"name":"validCodingValue(forKey:)","abstract":"Returns a value for a CodingKey that represents a field that","parent_name":"ValidKeyedCodingValueProvider"},"Protocols/ValidKeyedCodingValueProvider.html":{"name":"ValidKeyedCodingValueProvider","abstract":"
A protocol that your Codable type can adopt, in order to supply values"},"Protocols/ValidSingleCodingValueProvider.html":{"name":"ValidSingleCodingValueProvider","abstract":"
A protocol that your Codable type can adopt, in order to supply a"},"Extensions/UUID.html#/s:11TypeDecoder30ValidSingleCodingValueProviderP05valideF0ypSgyFZ":{"name":"validCodingValue()","parent_name":"UUID"},"Extensions/TimeZone.html#/s:11TypeDecoder29ValidKeyedCodingValueProviderP05valideF06forKeyypSgs0eJ0_p_tFZ":{"name":"validCodingValue(forKey:)","parent_name":"TimeZone"},"Extensions/URL.html#/s:11TypeDecoder29ValidKeyedCodingValueProviderP05valideF06forKeyypSgs0eJ0_p_tFZ":{"name":"validCodingValue(forKey:)","parent_name":"URL"},"Extensions/URL.html":{"name":"URL","abstract":"
Extension of the URL Foundation class that has validations to provide"},"Extensions/TimeZone.html":{"name":"TimeZone","abstract":"
Extension of the TimeZone Foundation class that has validations to provide"},"Extensions/UUID.html":{"name":"UUID","abstract":"
Extension of the UUID Foundation class that has validations to provide"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO6singleyACypXp_ypXptcACmF":{"name":"single(_:_:)","abstract":"
Case representing a simple type, such as a String, which is not recursive.
","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO5keyedyACypXp_AA17OrderedDictionaryVySSACGtcACmF":{"name":"keyed(_:_:)","abstract":"Case representing a struct or a class containing the object type as","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO12dynamicKeyedyACypXp_A2CtcACmF":{"name":"dynamicKeyed(_:key:value:)","abstract":"
Case representing a Dictionary containing the top level type of the","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO7unkeyedyACypXp_ACtcACmF":{"name":"unkeyed(_:_:)","abstract":"
Case representing an Array containing the top level type of the array","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO8optionalyA2CcACmF":{"name":"optional(_:)","abstract":"
Case representing an Optional type containing its nested type.
","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO6cyclicyACypXpcACmF":{"name":"cyclic(_:)","abstract":"Case representing a cyclic type so the associated type is the top level type.
","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO6opaqueyACypXpcACmF":{"name":"opaque(_:)","abstract":"Case representing a type that could not be decoded.
","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/hashValue":{"name":"hashValue","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"TypeInfo"},"Enums/TypeInfo.html":{"name":"TypeInfo","abstract":"Main enum used to describe a decoded type.
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"}}
--------------------------------------------------------------------------------
/docs/docsets/TypeDecoder.docset/Contents/Resources/Documents/search.json:
--------------------------------------------------------------------------------
1 | {"Structs/TypeDecoder.html#/s:11TypeDecoderAAV6decodeyAA0A4InfoOSe_pXpKFZ":{"name":"decode(_:)","abstract":"Returns a TypeInfo
","parent_name":"TypeDecoder"},"Structs/TypeDecodingError.html#/s:11TypeDecoder0A13DecodingErrorV7contexts0cD0O7ContextVvp":{"name":"context","abstract":"A description of the error and the underlying error, which is of type DecodingError.
","parent_name":"TypeDecodingError"},"Structs/OrderedDictionary.html#/s:11TypeDecoder17OrderedDictionaryVACyxq_Gycfc":{"name":"init()","abstract":"OrderedDictionary constructor.
","parent_name":"OrderedDictionary"},"Structs/OrderedDictionary.html#/s:11TypeDecoder17OrderedDictionaryV5countSivp":{"name":"count","abstract":"Read only property that provides the number of elements in the OrderedDictionary.
","parent_name":"OrderedDictionary"},"Structs/OrderedDictionary.html#/s:11TypeDecoder17OrderedDictionaryVyq_Sgxcip":{"name":"subscript(_:)","abstract":"Provides a way to add and remove elements from the","parent_name":"OrderedDictionary"},"Structs/OrderedDictionary.html#/s:11TypeDecoder17OrderedDictionaryVyq_SgSicip":{"name":"subscript(_:)","abstract":"
Return the element value at the numeric index specified.
","parent_name":"OrderedDictionary"},"Structs/OrderedDictionary.html#/s:11TypeDecoder17OrderedDictionaryV11descriptionSSvp":{"name":"description","abstract":"Read only property that provides a String containing the key:value pairs in the OrderedDictionary.
","parent_name":"OrderedDictionary"},"Structs/OrderedDictionary.html#/s:11TypeDecoder17OrderedDictionaryV4nextx_q_tSgyF":{"name":"next()","abstract":"Method to allow iteration over the contents of the","parent_name":"OrderedDictionary"},"Structs/OrderedDictionary.html":{"name":"OrderedDictionary"},"Structs/TypeDecodingError.html":{"name":"TypeDecodingError","abstract":"
An Error type indicating a problem during decoding by the TypeDecoder
"},"Structs/TypeDecoder.html":{"name":"TypeDecoder","abstract":"TypeDecoder allows you to decode a Swift type by using TypeDecoder.decode() and passing the type to"},"Protocols/ValidSingleCodingValueProvider.html#/s:11TypeDecoder30ValidSingleCodingValueProviderP05valideF0ypSgyFZ":{"name":"validCodingValue()","abstract":"
Returns a valid encoded representation of the conforming type.
","parent_name":"ValidSingleCodingValueProvider"},"Protocols/ValidKeyedCodingValueProvider.html#/s:11TypeDecoder29ValidKeyedCodingValueProviderP05valideF06forKeyypSgs0eJ0_p_tFZ":{"name":"validCodingValue(forKey:)","abstract":"Returns a value for a CodingKey that represents a field that","parent_name":"ValidKeyedCodingValueProvider"},"Protocols/ValidKeyedCodingValueProvider.html":{"name":"ValidKeyedCodingValueProvider","abstract":"
A protocol that your Codable type can adopt, in order to supply values"},"Protocols/ValidSingleCodingValueProvider.html":{"name":"ValidSingleCodingValueProvider","abstract":"
A protocol that your Codable type can adopt, in order to supply a"},"Extensions/UUID.html#/s:11TypeDecoder30ValidSingleCodingValueProviderP05valideF0ypSgyFZ":{"name":"validCodingValue()","parent_name":"UUID"},"Extensions/TimeZone.html#/s:11TypeDecoder29ValidKeyedCodingValueProviderP05valideF06forKeyypSgs0eJ0_p_tFZ":{"name":"validCodingValue(forKey:)","parent_name":"TimeZone"},"Extensions/URL.html#/s:11TypeDecoder29ValidKeyedCodingValueProviderP05valideF06forKeyypSgs0eJ0_p_tFZ":{"name":"validCodingValue(forKey:)","parent_name":"URL"},"Extensions/URL.html":{"name":"URL","abstract":"
Extension of the URL Foundation class that has validations to provide"},"Extensions/TimeZone.html":{"name":"TimeZone","abstract":"
Extension of the TimeZone Foundation class that has validations to provide"},"Extensions/UUID.html":{"name":"UUID","abstract":"
Extension of the UUID Foundation class that has validations to provide"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO6singleyACypXp_ypXptcACmF":{"name":"single(_:_:)","abstract":"
Case representing a simple type, such as a String, which is not recursive.
","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO5keyedyACypXp_AA17OrderedDictionaryVySSACGtcACmF":{"name":"keyed(_:_:)","abstract":"Case representing a struct or a class containing the object type as","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO12dynamicKeyedyACypXp_A2CtcACmF":{"name":"dynamicKeyed(_:key:value:)","abstract":"
Case representing a Dictionary containing the top level type of the","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO7unkeyedyACypXp_ACtcACmF":{"name":"unkeyed(_:_:)","abstract":"
Case representing an Array containing the top level type of the array","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO8optionalyA2CcACmF":{"name":"optional(_:)","abstract":"
Case representing an Optional type containing its nested type.
","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO6cyclicyACypXpcACmF":{"name":"cyclic(_:)","abstract":"Case representing a cyclic type so the associated type is the top level type.
","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:11TypeDecoder0A4InfoO6opaqueyACypXpcACmF":{"name":"opaque(_:)","abstract":"Case representing a type that could not be decoded.
","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:s28CustomDebugStringConvertibleP16debugDescriptionSSvp":{"name":"debugDescription","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:SH4hash4intoys6HasherVz_tF":{"name":"hash(into:)","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/hashValue":{"name":"hashValue","parent_name":"TypeInfo"},"Enums/TypeInfo.html#/s:SQ2eeoiySbx_xtFZ":{"name":"==(_:_:)","parent_name":"TypeInfo"},"Enums/TypeInfo.html":{"name":"TypeInfo","abstract":"Main enum used to describe a decoded type.
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"}}
--------------------------------------------------------------------------------
/docs/Extensions/UUID.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | UUID Extension Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
UUID
107 |
114 |
Extension of the UUID Foundation class that has validations to provide
115 | valid dummy values.
116 |
117 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
139 |
140 |
Declaration
141 |
142 |
Swift
143 |
public static func validCodingValue () -> Any ?
144 |
145 |
146 |
148 |
150 |
151 |
152 |
154 |
155 |
156 |
UUID Extension Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
UUID
107 |
114 |
Extension of the UUID Foundation class that has validations to provide
115 | valid dummy values.
116 |
117 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
139 |
140 |
Declaration
141 |
142 |
Swift
143 |
public static func validCodingValue () -> Any ?
144 |
145 |
146 |
148 |
150 |
151 |
152 |
154 |
155 |
156 |
URL Extension Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
URL
107 |
114 |
Extension of the URL Foundation class that has validations to provide
115 | valid dummy values.
116 |
117 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
139 |
140 |
Declaration
141 |
142 |
Swift
143 |
public static func validCodingValue ( forKey key : CodingKey ) -> Any ?
144 |
145 |
146 |
148 |
150 |
151 |
152 |
154 |
155 |
156 |
TimeZone Extension Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
TimeZone
107 |
114 |
Extension of the TimeZone Foundation class that has validations to provide
115 | valid dummy values.
116 |
117 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
139 |
140 |
Declaration
141 |
142 |
Swift
143 |
public static func validCodingValue ( forKey key : CodingKey ) -> Any ?
144 |
145 |
146 |
148 |
150 |
151 |
152 |
154 |
155 |
156 |
URL Extension Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
URL
107 |
114 |
Extension of the URL Foundation class that has validations to provide
115 | valid dummy values.
116 |
117 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
139 |
140 |
Declaration
141 |
142 |
Swift
143 |
public static func validCodingValue ( forKey key : CodingKey ) -> Any ?
144 |
145 |
146 |
148 |
150 |
151 |
152 |
154 |
155 |
156 |
TimeZone Extension Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
TimeZone
107 |
114 |
Extension of the TimeZone Foundation class that has validations to provide
115 | valid dummy values.
116 |
117 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
139 |
140 |
Declaration
141 |
142 |
Swift
143 |
public static func validCodingValue ( forKey key : CodingKey ) -> Any ?
144 |
145 |
146 |
148 |
150 |
151 |
152 |
154 |
155 |
156 |
TypeDecodingError Structure Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
TypeDecodingError
107 |
108 |
109 |
110 |
public struct TypeDecodingError : Error
111 |
112 |
113 |
114 |
An Error type indicating a problem during decoding by the TypeDecoder
115 |
116 |
This type provides additional guidance for Decodable types that do not
117 | conform to either the ValidSingleCodingValueProvider ValidKeyedCodingValueProvider
119 |
120 |
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 | context
133 |
134 |
136 |
137 |
138 |
139 |
140 |
A description of the error and the underlying error, which is of type DecodingError.
141 |
142 |
144 |
Declaration
145 |
146 |
Swift
147 |
public let context : DecodingError . Context
148 |
149 |
150 |
152 |
154 |
155 |
156 |
158 |
159 |
160 |
Enumerations Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
Enumerations
107 |
The following enumerations are available globally.
108 |
109 |
111 |
112 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
120 |
TypeInfo
121 |
122 |
123 |
124 |
125 |
126 |
127 |
128 | TypeInfo
131 |
132 |
134 |
135 |
136 |
137 |
138 |
Main enum used to describe a decoded type.
139 |
140 |
See more
141 |
143 |
Declaration
144 |
145 |
Swift
146 |
public indirect enum TypeInfo
147 |
extension TypeInfo : CustomDebugStringConvertible
148 |
extension TypeInfo : CustomStringConvertible
149 |
extension TypeInfo : Hashable
150 |
extension TypeInfo : Equatable
151 |
152 |
153 |
155 |
157 |
158 |
159 |
161 |
162 |
163 |
TypeDecodingError Structure Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
TypeDecodingError
107 |
108 |
109 |
110 |
public struct TypeDecodingError : Error
111 |
112 |
113 |
114 |
An Error type indicating a problem during decoding by the TypeDecoder
115 |
116 |
This type provides additional guidance for Decodable types that do not
117 | conform to either the ValidSingleCodingValueProvider ValidKeyedCodingValueProvider
119 |
120 |
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 | context
133 |
134 |
136 |
137 |
138 |
139 |
140 |
A description of the error and the underlying error, which is of type DecodingError.
141 |
142 |
144 |
Declaration
145 |
146 |
Swift
147 |
public let context : DecodingError . Context
148 |
149 |
150 |
152 |
154 |
155 |
156 |
158 |
159 |
160 |
Enumerations Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
Enumerations
107 |
The following enumerations are available globally.
108 |
109 |
111 |
112 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
120 |
TypeInfo
121 |
122 |
123 |
124 |
125 |
126 |
127 |
128 | TypeInfo
131 |
132 |
134 |
135 |
136 |
137 |
138 |
Main enum used to describe a decoded type.
139 |
140 |
See more
141 |
143 |
Declaration
144 |
145 |
Swift
146 |
public indirect enum TypeInfo
147 |
extension TypeInfo : CustomDebugStringConvertible
148 |
extension TypeInfo : CustomStringConvertible
149 |
extension TypeInfo : Hashable
150 |
extension TypeInfo : Equatable
151 |
152 |
153 |
155 |
157 |
158 |
159 |
161 |
162 |
163 |
TypeDecoder Structure Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
TypeDecoder
107 |
108 |
109 |
110 |
public struct TypeDecoder
111 |
112 |
113 |
114 |
TypeDecoder allows you to decode a Swift type by using TypeDecoder.decode() and passing the type to
115 | be decoded.
116 |
117 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
132 |
133 |
134 |
135 |
136 |
137 |
Returns a TypeInfo
138 |
Usage Example:
139 |
struct StructureType : Decodable {
140 | let aString : String
141 | }
142 |
143 | let structureTypeInfo = try TypeDecoder . decode ( StructureType . self )
144 |
145 |
146 |
148 |
Declaration
149 |
150 |
Swift
151 |
public static func decode ( _ type : Decodable . Type ) throws -> TypeInfo
152 |
153 |
154 |
156 |
158 |
159 |
160 |
162 |
163 |
164 |
TypeDecoder Structure Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
TypeDecoder
107 |
108 |
109 |
110 |
public struct TypeDecoder
111 |
112 |
113 |
114 |
TypeDecoder allows you to decode a Swift type by using TypeDecoder.decode() and passing the type to
115 | be decoded.
116 |
117 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
132 |
133 |
134 |
135 |
136 |
137 |
Returns a TypeInfo
138 |
Usage Example:
139 |
struct StructureType : Decodable {
140 | let aString : String
141 | }
142 |
143 | let structureTypeInfo = try TypeDecoder . decode ( StructureType . self )
144 |
145 |
146 |
148 |
Declaration
149 |
150 |
Swift
151 |
public static func decode ( _ type : Decodable . Type ) throws -> TypeInfo
152 |
153 |
154 |
156 |
158 |
159 |
160 |
162 |
163 |
164 |
ValidSingleCodingValueProvider Protocol Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
ValidSingleCodingValueProvider
107 |
108 |
109 |
110 |
public protocol ValidSingleCodingValueProvider
111 |
112 |
113 |
114 |
A protocol that your Codable type can adopt, in order to supply a
115 | valid value during decoding. This protocol is suitable for types that
116 | are represented by a single encoded value, such as an enum.
117 |
118 |
The TypeDecoder operates by constructing a ‘dummy’ instance of a type,
119 | via the init(from: Decoder) initializer. As there is no real data to
120 | be decoded, a dummy value (such as 0 or "") is provided. This
121 | may cause an initializer that requires a specific valid value to fail.
122 |
123 |
To enable such a type to work with TypeDecoder, define an extension
124 | that conforms the type to the ValidSingleCodingValueProvider protocol.
125 | The validCodingValue() function should return a valid encoded
126 | representation of that type.
127 |
Usage Example:
128 |
public enum Fruit : String , Codable {
129 | case apple , banana , orange , pear
130 | }
131 |
132 | // Provide an acceptable value during decoding
133 | extension Fruit : ValidSingleCodingValueProvider {
134 | public static func validCodingValue () -> Any ? {
135 | // Returns the string "apple"
136 | return self . apple . rawValue
137 | }
138 | }
139 |
140 |
141 |
143 |
144 |
145 |
146 |
147 |
148 |
149 |
156 |
157 |
158 |
159 |
160 |
161 |
Returns a valid encoded representation of the conforming type.
162 |
Usage Example:
163 |
self . apple . rawValue
164 |
165 |
166 |
168 |
Declaration
169 |
170 |
Swift
171 |
static func validCodingValue () -> Any ?
172 |
173 |
174 |
176 |
178 |
179 |
180 |
182 |
183 |
184 |
ValidSingleCodingValueProvider Protocol Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
ValidSingleCodingValueProvider
107 |
108 |
109 |
110 |
public protocol ValidSingleCodingValueProvider
111 |
112 |
113 |
114 |
A protocol that your Codable type can adopt, in order to supply a
115 | valid value during decoding. This protocol is suitable for types that
116 | are represented by a single encoded value, such as an enum.
117 |
118 |
The TypeDecoder operates by constructing a ‘dummy’ instance of a type,
119 | via the init(from: Decoder) initializer. As there is no real data to
120 | be decoded, a dummy value (such as 0 or "") is provided. This
121 | may cause an initializer that requires a specific valid value to fail.
122 |
123 |
To enable such a type to work with TypeDecoder, define an extension
124 | that conforms the type to the ValidSingleCodingValueProvider protocol.
125 | The validCodingValue() function should return a valid encoded
126 | representation of that type.
127 |
Usage Example:
128 |
public enum Fruit : String , Codable {
129 | case apple , banana , orange , pear
130 | }
131 |
132 | // Provide an acceptable value during decoding
133 | extension Fruit : ValidSingleCodingValueProvider {
134 | public static func validCodingValue () -> Any ? {
135 | // Returns the string "apple"
136 | return self . apple . rawValue
137 | }
138 | }
139 |
140 |
141 |
143 |
144 |
145 |
146 |
147 |
148 |
149 |
156 |
157 |
158 |
159 |
160 |
161 |
Returns a valid encoded representation of the conforming type.
162 |
Usage Example:
163 |
self . apple . rawValue
164 |
165 |
166 |
168 |
Declaration
169 |
170 |
Swift
171 |
static func validCodingValue () -> Any ?
172 |
173 |
174 |
176 |
178 |
179 |
180 |
182 |
183 |
184 |
Extensions Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
Extensions
107 |
The following extensions are available globally.
108 |
109 |
111 |
112 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
120 |
Validation
121 |
122 |
123 |
124 |
125 |
126 |
127 |
128 | URL
131 |
132 |
134 |
135 |
136 |
137 |
138 |
Extension of the URL Foundation class that has validations to provide
139 | valid dummy values.
140 |
141 |
See more
142 |
144 |
Declaration
145 |
150 |
152 |
154 |
155 |
156 |
157 | TimeZone
160 |
161 |
163 |
164 |
165 |
166 |
167 |
Extension of the TimeZone Foundation class that has validations to provide
168 | valid dummy values.
169 |
170 |
See more
171 |
173 |
Declaration
174 |
179 |
181 |
183 |
184 |
185 |
186 | UUID
189 |
190 |
192 |
193 |
194 |
195 |
196 |
Extension of the UUID Foundation class that has validations to provide
197 | valid dummy values.
198 |
199 |
See more
200 |
202 |
Declaration
203 |
208 |
210 |
212 |
213 |
214 |
216 |
217 |
218 |
Extensions Reference
5 |
45 | TypeDecoder Reference
46 |
49 |
50 |
51 |
52 |
101 |
102 |
103 |
104 |
105 |
106 |
Extensions
107 |
The following extensions are available globally.
108 |
109 |
111 |
112 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
120 |
Validation
121 |
122 |
123 |
124 |
125 |
126 |
127 |
128 | URL
131 |
132 |
134 |
135 |
136 |
137 |
138 |
Extension of the URL Foundation class that has validations to provide
139 | valid dummy values.
140 |
141 |
See more
142 |
144 |
Declaration
145 |
150 |
152 |
154 |
155 |
156 |
157 | TimeZone
160 |
161 |
163 |
164 |
165 |
166 |
167 |
Extension of the TimeZone Foundation class that has validations to provide
168 | valid dummy values.
169 |
170 |
See more
171 |
173 |
Declaration
174 |
179 |
181 |
183 |
184 |
185 |
186 | UUID
189 |
190 |
192 |
193 |
194 |
195 |
196 |
Extension of the UUID Foundation class that has validations to provide
197 | valid dummy values.
198 |
199 |
See more
200 |
202 |
Declaration
203 |
208 |
210 |
212 |
213 |
214 |
216 |
217 |
218 |
38 | View on GitHub
39 | 
47 | UUID Extension Reference
48 | 
38 | View on GitHub
39 | 
47 | Enumerations Reference
48 |