Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/almazrafi/dictionarycoder
Fast dictionary encoder / decoder for Swift Codable types
https://github.com/almazrafi/dictionarycoder
carthage cocoapods codable decodable dictionaryencoder encodable ios macos spm swift tvos watchos xcode
Last synced: about 1 month ago
JSON representation
Fast dictionary encoder / decoder for Swift Codable types
- Host: GitHub
- URL: https://github.com/almazrafi/dictionarycoder
- Owner: almazrafi
- License: mit
- Created: 2020-01-29T15:27:13.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T21:55:30.000Z (7 months ago)
- Last Synced: 2024-11-18T03:42:12.344Z (about 1 month ago)
- Topics: carthage, cocoapods, codable, decodable, dictionaryencoder, encodable, ios, macos, spm, swift, tvos, watchos, xcode
- Language: Swift
- Homepage:
- Size: 129 KB
- Stars: 58
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DictionaryCoder
[](https://github.com/almazrafi/DictionaryCoder/actions)
[](https://codecov.io/gh/almazrafi/DictionaryCoder)
[](http://cocoapods.org/pods/DictionaryCoder)
[](https://github.com/Carthage/Carthage)
[](https://swift.org/package-manager/)
[](https://developer.apple.com/discover/)
[](https://developer.apple.com/xcode)
[](https://swift.org)
[](https://opensource.org/licenses/MIT)
## Requirements
- iOS 12.0+ / macOS 10.14+ / watchOS 5.0+ / tvOS 12.0+
- Xcode 13.0+
- Swift 5.5+
## Usage
```swift
struct User: Codable {
var id: Int
var name: String
}
// Encode to [String: Any]
let user = User(id: 123, name: "Neo")
let dictionary = try DictionaryEncoder().encode(user)
// Decode from [String: Any]
let dictionary: [String: Any] = ["id": 123, "name": "Neo"]
let user = try DictionaryDecoder().decode(User.self, from: dictionary)
```
## Installation
### CocoaPods
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
``` bash
$ gem install cocoapods
```
To integrate DictionaryCoder into your Xcode project using [CocoaPods](http://cocoapods.org), specify it in your `Podfile`:
``` ruby
platform :ios, '12.0'
use_frameworks!
target '' do
pod 'DictionaryCoder'
end
```
Finally run the following command:
``` bash
$ pod install
```
### Carthage
[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. You can install Carthage with Homebrew using the following command:
``` bash
$ brew update
$ brew install carthage
```
To integrate DictionaryCoder into your Xcode project using Carthage, specify it in your `Cartfile`:
``` ogdl
github "almazrafi/DictionaryCoder" ~> 1.2.0
```
Finally run `carthage update` to build the framework and drag the built `DictionaryCoder.framework` into your Xcode project.
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.
To integrate DictionaryCoder into your Xcode project using Swift Package Manager,
add the following as a dependency to your `Package.swift`:
``` swift
.package(url: "https://github.com/almazrafi/DictionaryCoder.git", from: "1.2.0")
```
and then specify `"DictionaryCoder"` as a dependency of the Target in which you wish to use DictionaryCoder.
Here's an example `Package.swift`:
``` swift
// swift-tools-version:5.5
import PackageDescription
let package = Package(
name: "MyPackage",
products: [
.library(name: "MyPackage", targets: ["MyPackage"])
],
dependencies: [
.package(url: "https://github.com/almazrafi/DictionaryCoder.git", from: "1.2.0")
],
targets: [
.target(name: "MyPackage", dependencies: ["DictionaryCoder"])
]
)
```
## Communication
- If you need help, open an issue.
- If you found a bug, open an issue.
- If you have a feature request, open an issue.
- If you want to contribute, submit a pull request.
## License
DictionaryCoder is available under the MIT license. See the [LICENSE](LICENSE) file for more info.