DefaultCacheSerializer
public struct DefaultCacheSerializer : CacheSerializer
Represents a basic and default CacheSerializer
used in Kingfisher disk cache system.
It could serialize and deserialize images in PNG, JPEG and GIF format. For
image other than these formats, a normalized pngRepresentation
will be used.
-
The default general cache serializer used across Kingfisher’s cache.
Declaration
Swift
public static let `default`: DefaultCacheSerializer
-
The compression quality when converting image to a lossy format data. Default is 1.0.
Declaration
Swift
public var compressionQuality: CGFloat
-
Whether the original data should be preferred when serializing the image. If
true
, the input original data will be checked first and used unless the data isnil
. In that case, the serialization will fall back to creating data from image.Declaration
Swift
public var preferCacheOriginalData: Bool
-
Creates a cache serializer that serialize and deserialize images in PNG, JPEG and GIF format.
Note
UseDefaultCacheSerializer.default
unless you need to specify your own properties.Declaration
Swift
public init()
-
Note
Only when
original
contains valid PNG, JPEG and GIF format data, theimage
will be converted to the corresponding data type. Otherwise, if theoriginal
is provided but it is not Iforiginal
isnil
, the inputimage
will be encoded as PNG data.Declaration
Swift
public func data(with image: KFCrossPlatformImage, original: Data?) -> Data?
Parameters
image
The image needed to be serialized.
original
The original data which is just downloaded. If the image is retrieved from cache instead of downloaded, it will be
nil
.Return Value
The data object for storing to disk, or
nil
when no valid data could be serialized. -
Gets an image deserialized from provided data.
Declaration
Swift
public func image(with data: Data, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage?
Parameters
data
The data from which an image should be deserialized.
options
Options for deserialization.
Return Value
An image deserialized or
nil
when no valid image could be deserialized.