-
-
Notifications
You must be signed in to change notification settings - Fork 532
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move ImageContainer to a separate file
- Loading branch information
Showing
3 changed files
with
102 additions
and
93 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| // The MIT License (MIT) | ||
| // | ||
| // Copyright (c) 2015-2022 Alexander Grebenyuk (github.com/kean). | ||
|
|
||
| #if !os(watchOS) | ||
| import AVKit | ||
| #endif | ||
|
|
||
| import Foundation | ||
|
|
||
| #if !os(macOS) | ||
| import UIKit.UIImage | ||
| /// Alias for `UIImage`. | ||
| public typealias PlatformImage = UIImage | ||
| #else | ||
| import AppKit.NSImage | ||
| /// Alias for `NSImage`. | ||
| public typealias PlatformImage = NSImage | ||
| #endif | ||
|
|
||
| /// An image container with an image and associated metadata. | ||
| public struct ImageContainer: @unchecked Sendable { | ||
| #if os(macOS) | ||
| /// A fetched image. | ||
| public var image: NSImage | ||
| #else | ||
| /// A fetched image. | ||
| public var image: UIImage | ||
| #endif | ||
|
|
||
| /// An image type. | ||
| public var type: AssetType? | ||
|
|
||
| /// Returns `true` if the image in the container is a preview of the image. | ||
| public var isPreview: Bool | ||
|
|
||
| /// Contains the original image `data`, but only if the decoder decides to | ||
| /// attach it to the image. | ||
| /// | ||
| /// The default decoder (`ImageDecoders.Default`) attaches data to GIFs to | ||
| /// allow to display them using a rendering engine of your choice. | ||
| /// | ||
| /// - note: The `data`, along with the image container itself gets stored | ||
| /// in the memory cache. | ||
| public var data: Data? | ||
|
|
||
| #if !os(watchOS) | ||
| /// Represents in-memory video asset. | ||
| public var asset: AVAsset? | ||
| #endif | ||
|
|
||
| /// An metadata provided by the user. | ||
| public var userInfo: [UserInfoKey: Any] | ||
|
|
||
| /// Initializes the container with the given image. | ||
| public init(image: PlatformImage, type: AssetType? = nil, isPreview: Bool = false, data: Data? = nil, userInfo: [UserInfoKey: Any] = [:]) { | ||
| self.image = image | ||
| self.type = type | ||
| self.isPreview = isPreview | ||
| self.data = data | ||
| self.userInfo = userInfo | ||
|
|
||
| #if !os(watchOS) | ||
| if type?.isVideo == true { | ||
| self.asset = data.flatMap { AVDataAsset(data: $0, type: type) } | ||
| } | ||
| #endif | ||
| } | ||
|
|
||
| func map(_ closure: (PlatformImage) throws -> PlatformImage) rethrows -> ImageContainer { | ||
| var copy = self | ||
| copy.image = try closure(image) | ||
| return copy | ||
| } | ||
|
|
||
| /// A key use in `userInfo`. | ||
| public struct UserInfoKey: Hashable, ExpressibleByStringLiteral, Sendable { | ||
| public let rawValue: String | ||
|
|
||
| public init(_ rawValue: String) { | ||
| self.rawValue = rawValue | ||
| } | ||
|
|
||
| public init(stringLiteral value: String) { | ||
| self.rawValue = value | ||
| } | ||
|
|
||
| // For internal purposes. | ||
| static let isThumbnailKey: UserInfoKey = "com.github/kean/nuke/skip-decompression" | ||
|
|
||
| /// A user info key to get the scan number (Int). | ||
| public static let scanNumberKey: UserInfoKey = "com.github/kean/nuke/scan-number" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters