Programming language: Swift
License: MIT License
Tags: Data Management     CBOR    
Add another 'CBOR' Library



Codacy Badge License MIT CocoaPods Compatible Carthage Compatible Platform Code Coverage

Swift Package Xcode Project Cocoapods Carthage

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.


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")


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)


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 Codable relies on CodingKey for encoding/decoding its keyed containers, this framework is limited in its supported key types to Int and String.
  • 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 Int64 or UInt64 type.

For more information about the CBOR format see: CBOR & RFC 7049.


  • Add additional options to CBOREncoder and CBORDecoder.


If you have need for a specific feature or you encounter a bug, please open an issue. If you extend the functionality of CBORCoding yourself or you feel like fixing a bug yourself, please submit a pull request.


Joseph Newton, [email protected]


CBORCoding is based heavily on the JSONEncoder/JSONDecoder classes provided by Swift. See ATTRIBUTIONS for more details.


CBORCoding is available under the MIT license. See the LICENSE file for more info.

*Note that all licence references and agreements mentioned in the CBORCoding README section above are relevant to that project's source code only.