1- #if canImport(FoundationEssentials)
2- import FoundationEssentials
3- #elseif canImport(Foundation)
4- import Foundation
5- #endif
6-
71// MARK: - Error Types
82
93/// Errors that can occur during CBOR encoding and decoding.
104///
115/// These errors provide detailed information about what went wrong during
126/// CBOR processing operations, helping developers diagnose and fix issues
137/// in their CBOR data or usage of the CBOR API.
14- public enum CBORError : Error {
8+ public enum CBORError : Error , Equatable , Sendable {
159 /// The input data is not valid CBOR.
1610 ///
1711 /// This error occurs when the decoder encounters data that doesn't conform to
1812 /// the CBOR specification (RFC 8949). This could be due to corrupted data,
1913 /// incomplete data, or data encoded with a different format entirely.
2014 case invalidCBOR
2115
22- /// Expected a specific type but found another.
23- ///
24- /// This error occurs when trying to decode a CBOR value as a specific type,
25- /// but the actual type of the value doesn't match the expected type.
26- /// - Parameters:
27- /// - expected: The type that was expected (e.g., "String", "Int", "Array")
28- /// - actual: The actual type that was found in the CBOR data
29- case typeMismatch( expected: String , actual: String )
30-
31- /// Array index out of bounds.
32- ///
33- /// This error occurs when attempting to access an element in a CBOR array
34- /// using an index that is outside the valid range for the array.
35- /// - Parameters:
36- /// - index: The requested index that was attempted to be accessed
37- /// - count: The actual number of elements in the array (valid indices are 0..<count)
38- case outOfBounds( index: Int , count: Int )
39-
40- /// Required key missing from map.
41- ///
42- /// This error occurs when trying to decode a CBOR map into a Swift struct or class,
43- /// but a required key is not present in the map.
44- /// - Parameter key: The name of the missing key
45- case missingKey( String )
46-
47- /// Value conversion failed.
48- ///
49- /// This error occurs when a CBOR value cannot be converted to the requested Swift type,
50- /// even though the CBOR type is compatible with the requested type.
51- /// - Parameter message: A description of what went wrong during the conversion
52- case valueConversionFailed( String )
53-
5416 /// Invalid UTF-8 string data.
5517 ///
5618 /// This error occurs when decoding a CBOR text string that contains invalid UTF-8 sequences.
5719 /// All CBOR text strings must contain valid UTF-8 data according to the specification.
5820 case invalidUTF8
5921
60- /// Integer overflow during encoding/decoding.
61- ///
62- /// This error occurs when a CBOR integer value is too large to fit into the
63- /// corresponding Swift integer type (e.g., trying to decode a UInt64.max into an Int).
64- case integerOverflow
65-
66- /// Tag value is not supported.
67- ///
68- /// This error occurs when the decoder encounters a CBOR tag that is not supported
69- /// by the current implementation.
70- /// - Parameter tag: The unsupported tag number
71- case unsupportedTag( UInt64 )
72-
7322 /// Reached end of data while decoding.
7423 ///
7524 /// This error occurs when the decoder unexpectedly reaches the end of the input data
@@ -105,26 +54,15 @@ public enum CBORError: Error {
10554 case extraDataFound
10655}
10756
57+ @_unavailableInEmbedded
10858extension CBORError : CustomStringConvertible {
10959 /// A human-readable description of the error.
11060 public var description : String {
11161 switch self {
11262 case . invalidCBOR:
11363 return " Invalid CBOR data: The input does not conform to the CBOR specification (RFC 8949) "
114- case . typeMismatch( let expected, let actual) :
115- return " Type mismatch: expected \( expected) , found \( actual) "
116- case . outOfBounds( let index, let count) :
117- return " Array index out of bounds: attempted to access index \( index) , but array only contains \( count) elements (valid indices are 0..< \( count) ) "
118- case . missingKey( let key) :
119- return " Missing key: required key ' \( key) ' was not found in the CBOR map "
120- case . valueConversionFailed( let message) :
121- return " Value conversion failed: \( message) "
12264 case . invalidUTF8:
12365 return " Invalid UTF-8 data: the CBOR text string contains invalid UTF-8 sequences "
124- case . integerOverflow:
125- return " Integer overflow: the CBOR integer value is too large for the target Swift integer type "
126- case . unsupportedTag( let tag) :
127- return " Unsupported tag: tag \( tag) is not supported by this implementation "
12866 case . prematureEnd:
12967 return " Unexpected end of data: reached the end of input before completing the CBOR value "
13068 case . invalidInitialByte( let byte) :
@@ -139,6 +77,13 @@ extension CBORError: CustomStringConvertible {
13977 }
14078}
14179
80+ #if canImport(FoundationEssentials)
81+ import FoundationEssentials
82+ #elseif canImport(Foundation)
83+ import Foundation
84+ #endif
85+
86+ @_unavailableInEmbedded
14287extension CBORError : LocalizedError {
14388 public var errorDescription : String ? {
14489 return description
0 commit comments