iOS/Pods/Kingfisher/Sources/Resource.swift

   1 //
   2 //  Resource.swift
   3 //  Kingfisher
   4 //
   5 //  Created by Wei Wang on 15/4/6.
   6 //
   7 //  Copyright (c) 2018 Wei Wang <onevcat@gmail.com>
   8 //
   9 //  Permission is hereby granted, free of charge, to any person obtaining a copy
  10 //  of this software and associated documentation files (the "Software"), to deal
  11 //  in the Software without restriction, including without limitation the rights
  12 //  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13 //  copies of the Software, and to permit persons to whom the Software is
  14 //  furnished to do so, subject to the following conditions:
  15 //
  16 //  The above copyright notice and this permission notice shall be included in
  17 //  all copies or substantial portions of the Software.
  18 //
  19 //  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20 //  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21 //  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22 //  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23 //  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24 //  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25 //  THE SOFTWARE.
  26
  27 import Foundation
  28
  29
  30 /// `Resource` protocol defines how to download and cache a resource from network.
  31 public protocol Resource {
  32     /// The key used in cache.
  33     var cacheKey: String { get }
  34
  35     /// The target image URL.
  36     var downloadURL: URL { get }
  37 }
  38
  39 /**
  40  ImageResource is a simple combination of `downloadURL` and `cacheKey`.
  41
  42  When passed to image view set methods, Kingfisher will try to download the target
  43  image from the `downloadURL`, and then store it with the `cacheKey` as the key in cache.
  44  */
  45 public struct ImageResource: Resource {
  46     /// The key used in cache.
  47     public let cacheKey: String
  48
  49     /// The target image URL.
  50     public let downloadURL: URL
  51
  52     /**
  53      Create a resource.
  54
  55      - parameter downloadURL: The target image URL.
  56      - parameter cacheKey:    The cache key. If `nil`, Kingfisher will use the `absoluteString` of `downloadURL` as the key.
  57
  58      - returns: A resource.
  59      */
  60     public init(downloadURL: URL, cacheKey: String? = nil) {
  61         self.downloadURL = downloadURL
  62         self.cacheKey = cacheKey ?? downloadURL.absoluteString
  63     }
  64 }
  65
  66 /**
  67  URL conforms to `Resource` in Kingfisher.
  68  The `absoluteString` of this URL is used as `cacheKey`. And the URL itself will be used as `downloadURL`.
  69  If you need customize the url and/or cache key, use `ImageResource` instead.
  70  */
  71 extension URL: Resource {
  72     public var cacheKey: String { return absoluteString }
  73     public var downloadURL: URL { return self }
  74 }