Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SomeRandomiOSDev/CBORCoding
Easy CBOR encoding and decoding for iOS, macOS, tvOS and watchOS.
https://github.com/SomeRandomiOSDev/CBORCoding
carthage cbor cocoapods hacktoberfest ios macos swift swiftpm tvos watchos
Last synced: 10 days ago
JSON representation
Easy CBOR encoding and decoding for iOS, macOS, tvOS and watchOS.
- Host: GitHub
- URL: https://github.com/SomeRandomiOSDev/CBORCoding
- Owner: SomeRandomiOSDev
- License: mit
- Created: 2019-06-05T02:02:17.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-15T20:43:02.000Z (12 months ago)
- Last Synced: 2024-10-03T02:54:14.097Z (about 1 month ago)
- Topics: carthage, cbor, cocoapods, hacktoberfest, ios, macos, swift, swiftpm, tvos, watchos
- Language: Swift
- Homepage:
- Size: 639 KB
- Stars: 48
- Watchers: 1
- Forks: 11
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- fucking-awesome-swift - CBORCoding - Easy CBOR encoding and decoding for iOS, macOS, tvOS and watchOS. (Libs / Data Management)
- awesome-swift - CBORCoding - Easy CBOR encoding and decoding for iOS, macOS, tvOS and watchOS. (Libs / Data Management)
README
# CBORCoding
[](https://cocoapods.org/pods/CBORCoding)
[](https://cocoapods.org/pods/CBORCoding)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/CBORCoding)
[](https://codecov.io/gh/SomeRandomiOSDev/CBORCoding)
[](https://github.com/SomeRandomiOSDev/CBORCoding/actions/workflows/carthage.yml)
[](https://github.com/SomeRandomiOSDev/CBORCoding/actions/workflows/cocoapods.yml)
[](https://github.com/SomeRandomiOSDev/CBORCoding/actions/workflows/documentation.yml)
[](https://github.com/SomeRandomiOSDev/CBORCoding/actions/workflows/swift-package.yml)
[](https://github.com/SomeRandomiOSDev/CBORCoding/actions/workflows/swiftlint.yml)
[](https://github.com/SomeRandomiOSDev/CBORCoding/actions/workflows/xcframework.yml)
[](https://github.com/SomeRandomiOSDev/CBORCoding/actions/workflows/xcodebuild.yml)
**CBORCoding** is a lightweight framework containing a coder pair for encoding and decoding `Codable` conforming types to and from [CBOR](https://cbor.io) document format for iOS, macOS, tvOS, and watchOS.
## Installation
**CBORCoding** is available through [CocoaPods](https://cocoapods.org), [Carthage](https://github.com/Carthage/Carthage) and the [Swift Package Manager](https://swift.org/package-manager/).
To install via CocoaPods, simply add the following line to your Podfile:
```ruby
pod 'CBORCoding'
```
To install via Carthage, simply add the following line to your Cartfile:
```ruby
github "SomeRandomiOSDev/CBORCoding"
```
To install via the Swift Package Manager add the following line to your `Package.swift` file's `dependencies`:
```swift
.package(url: "https://github.com/SomeRandomiOSDev/CBORCoding.git", from: "1.0.0")
```
## Usage
First import **CBORCoding** at the top of your Swift file:
```swift
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:
```swift
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:
```swift
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 `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](https://cbor.io) & [RFC 8949](https://datatracker.ietf.org/doc/html/rfc8949).
## 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](.github/CONTRIBUTING.md) 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.