update

Pods/Kingfisher/Sources/General/ImageSource/Source.swift

@@ -0,0 +1,116 @@
+//
+//  Source.swift
+//  Kingfisher
+//
+//  Created by onevcat on 2018/11/17.
+//
+//  Copyright (c) 2019 Wei Wang <onevcat@gmail.com>
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+
+import Foundation
+
+/// Represents an image setting source for Kingfisher methods.
+///
+/// A `Source` value indicates the way how the target image can be retrieved and cached.
+///
+/// - network: The target image should be got from network remotely. The associated `Resource`
+///            value defines detail information like image URL and cache key.
+/// - provider: The target image should be provided in a data format. Normally, it can be an image
+///             from local storage or in any other encoding format (like Base64).
+public enum Source {
+
+    /// Represents the source task identifier when setting an image to a view with extension methods.
+    public enum Identifier {
+
+        /// The underlying value type of source identifier.
+        public typealias Value = UInt
+        static private(set) var current: Value = 0
+        static func next() -> Value {
+            current += 1
+            return current
+        }
+    }
+
+    // MARK: Member Cases
+
+    /// The target image should be got from network remotely. The associated `Resource`
+    /// value defines detail information like image URL and cache key.
+    case network(Resource)
+    
+    /// The target image should be provided in a data format. Normally, it can be an image
+    /// from local storage or in any other encoding format (like Base64).
+    case provider(ImageDataProvider)
+
+    // MARK: Getting Properties
+
+    /// The cache key defined for this source value.
+    public var cacheKey: String {
+        switch self {
+        case .network(let resource): return resource.cacheKey
+        case .provider(let provider): return provider.cacheKey
+        }
+    }
+
+    /// The URL defined for this source value.
+    ///
+    /// For a `.network` source, it is the `downloadURL` of associated `Resource` instance.
+    /// For a `.provider` value, it is always `nil`.
+    public var url: URL? {
+        switch self {
+        case .network(let resource): return resource.downloadURL
+        case .provider(let provider): return provider.contentURL
+        }
+    }
+}
+
+extension Source: Hashable {
+    public static func == (lhs: Source, rhs: Source) -> Bool {
+        switch (lhs, rhs) {
+        case (.network(let r1), .network(let r2)):
+            return r1.cacheKey == r2.cacheKey && r1.downloadURL == r2.downloadURL
+        case (.provider(let p1), .provider(let p2)):
+            return p1.cacheKey == p2.cacheKey && p1.contentURL == p2.contentURL
+        case (.provider(_), .network(_)):
+            return false
+        case (.network(_), .provider(_)):
+            return false
+        }
+    }
+
+    public func hash(into hasher: inout Hasher) {
+        switch self {
+        case .network(let r):
+            hasher.combine(r.cacheKey)
+            hasher.combine(r.downloadURL)
+        case .provider(let p):
+            hasher.combine(p.cacheKey)
+            hasher.combine(p.contentURL)
+        }
+    }
+}
+
+extension Source {
+    var asResource: Resource? {
+        guard case .network(let resource) = self else {
+            return nil
+        }
+        return resource
+    }
+}