OrderedDictionary is a lightweight implementation of an ordered dictionary data structure in Swift.
The OrderedDictionary struct is a generic collection which combines the features of Dictionary and Array from the Swift standard library. Like Dictionary it stores key-value pairs with each key being unique and maps each key to an associated value. Like Array it stores those pairs sorted and accessible by a zero-based integer index.
OrderedDictionary provides similar APIs like collections from the Swift standard library. This includes accessing contents by keys or indices, inserting and removing elements, iterating, sorting etc.
Internally, OrderedDictionary uses a backing store composed of an instance of Dictionary for storing the key-value pairs and an instance of Array for managing the ordered keys. This means it is not the most performant implementation possible, but it gets its job done by reusing most functionality from the Swift standard library.
- Swift 4.0+ (4.0, 4.2, 5.0, 5.1)
- Xcode 9.2+
- iOS 8.0+ / macOS 10.10+
The library is distributed as a Swift framework and can be integrated into your project in following ways:
If you use Carthage for managing your dependencies, put OrderedDictionary into your Cartfile:
github "lukaskubanek/OrderedDictionary"
Then, drag either the OrderedDictionary.xcodeproj or the OrderedDictionary.framework into your project/workspace and link your target against the OrderedDictionary.framework. Also make sure that the framework gets copied to your application bundle.
Another option is to use the Swift Package Manager. If you prefer this option, put OrderedDictionary as a dependency to your Package.swift:
.package(url: "https://github.com/lukaskubanek/OrderedDictionary.git", from: "2.3.0")
Yet another option is using Git submodules and integrating the Xcode project OrderedDictionary.xcodeproj from the submodule directly to your Xcode workspace.
Although there is high demand for CocoaPods support, this method won't be officially supported by this library. Since I'm not using CocoaPods myself and since I think this method will be once replaced by the Swift Package Manager, I don't want to put any effort in maintaining an official podspec. If you really want to include this library via CocoaPods, there is still a way by creating a custom podspec (see the last section of this post).
For the usage of this library please refer to the example playground. For documentation please refer to the documentation comments.
The changelog is managed on the GitHub releases page.
Lukas Kubanek // lukaskubanek.com // @kubanekl
OrderedDictionary is provided under the MIT License.