CBORCoding
CBORCoding is a lightweight framework containing a coder pair for encoding and decoding Codable conforming types to and from CBOR document format for iOS, macOS, tvOS, and watchOS.
Installation
CBORCoding is available through CocoaPods, Carthage and the Swift Package Manager.
To install via CocoaPods, simply add the following line to your Podfile:
pod 'CBORCoding'
To install via Carthage, simply add the following line to your Cartfile:
github "SomeRandomiOSDev/CBORCoding"
To install via the Swift Package Manager add the following line to your Package.swift file's dependencies:
.package(url: "https://github.com/SomeRandomiOSDev/CBORCoding.git", from: "1.0.0")
Usage
First import CBORCoding at the top of your Swift file:
import CBORCoding
After importing, the use is nearly identical to that of the JSONEncoder/JSONDecoder class pair provided by the Swift Foundation library. This example shows how to encode an instance of a simple Car type to a CBOR object:
struct Car: Codable {
var manufacturer: String
var model: String
var horsePower: Int
var description: String?
}
let stinger = Car(manufacturer: "Kia", model: "Stinger GT2", horsePower: 365, description: nil)
let encoder = CBOREncoder()
let encodedData = try encoder.encode(stinger)
print("CBOR: \(hexString(encodedData))")
/* Prints:
CBOR: 0xA36C6D616E756661637475726572634B6961656D6F64656C6B5374696E676572204754326A686F727365506F77657219016D
*/
This example shows how to decode that encoded Car value at a later time:
let decoder = CBORDecoder()
let stinger = try decoder.decode(Car.self, from: encodedData)
CBOR
Concise Binary Object Representation is a data format for being able to encode formatted data with a goal of a having as small a message size as possible.
While this framework implements as much of the specification as possible, there are a few notable exceptions:
- CBOR supports keys of any defined type, however, since
Codablerelies onCodingKeyfor encoding/decoding its keyed containers, this framework is limited in its supported key types toIntandString. - CBOR supports DecimalFractions and Bigfloats whose mantissa is a Bignum. With the current implementation, this is limited to Bignums whose content fits into either a
Int64orUInt64type.
For more information about the CBOR format see: CBOR & RFC 8949.
Contributing
Whether it's submitting a feature request, reporting a bug, or writing code yourself, all contributions to this library are welcome! Please see CONTRIBUTING for more information on how you can contribute.
Author
Joe Newton, [email protected]
Credits
CBORCoding is based heavily on the JSONEncoder/JSONDecoder classes provided by Swift. See ATTRIBUTIONS for more details.
License
CBORCoding is available under the MIT license. See the LICENSE file for more info.
28 Aug 28, 2022
34 Dec 27, 2022
113 Sep 9, 2022
119 Dec 20, 2022
82 Oct 5, 2022
2 Jan 26, 2022
582 Dec 25, 2022
833 Jan 3, 2023
145 Sep 10, 2022
1.5k Dec 29, 2022
10 Sep 5, 2022
3 Jul 10, 2022
0 Dec 28, 2021
5 Jan 3, 2023
1 May 27, 2022
6 Sep 26, 2022
2 Oct 13, 2022
4 Aug 24, 2022
82 Jan 3, 2023