DefaultsKey.swift 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. //
  2. // SwiftyUserDefaults
  3. //
  4. // Copyright (c) 2015-present Radosław Pietruszewski, Łukasz Mróz
  5. //
  6. // Permission is hereby granted, free of charge, to any person obtaining a copy
  7. // of this software and associated documentation files (the "Software"), to deal
  8. // in the Software without restriction, including without limitation the rights
  9. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. // copies of the Software, and to permit persons to whom the Software is
  11. // furnished to do so, subject to the following conditions:
  12. //
  13. // The above copyright notice and this permission notice shall be included in all
  14. // copies or substantial portions of the Software.
  15. //
  16. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22. // SOFTWARE.
  23. //
  24. import Foundation
  25. // MARK: - Static keys
  26. /// Specialize with value type
  27. /// and pass key name to the initializer to create a key.
  28. public struct DefaultsKey<ValueType: DefaultsSerializable> {
  29. public let _key: String
  30. public let defaultValue: ValueType.T?
  31. internal var isOptional: Bool
  32. public init(_ key: String, defaultValue: ValueType.T) {
  33. self._key = key
  34. self.defaultValue = defaultValue
  35. self.isOptional = false
  36. }
  37. // Couldn't figure out a way of how to pass a nil/none value from extension, thus this initializer.
  38. // Used for creating an optional key (without defaultValue)
  39. private init(key: String) {
  40. self._key = key
  41. self.defaultValue = nil
  42. self.isOptional = true
  43. }
  44. @available(*, unavailable, message: "This key needs a `defaultValue` parameter. If this type does not have a default value, consider using an optional key.")
  45. public init(_ key: String) {
  46. fatalError()
  47. }
  48. }
  49. public extension DefaultsKey where ValueType: DefaultsSerializable, ValueType: OptionalType, ValueType.Wrapped: DefaultsSerializable {
  50. init(_ key: String) {
  51. self.init(key: key)
  52. }
  53. init(_ key: String, defaultValue: ValueType.T) {
  54. self._key = key
  55. self.defaultValue = defaultValue
  56. self.isOptional = true
  57. }
  58. }