Protocols

The following protocols are available globally.

  • An CacheSerializer is used to convert some data to an image object after retrieving it from disk storage, and vice versa, to convert an image to data object for storing to the disk storage.

    See more

    Declaration

    Swift

    public protocol CacheSerializer
  • Represents types which cost in memory can be calculated.

    See more

    Declaration

    Swift

    public protocol CacheCostCalculable
  • Represents types which can be converted to and from data.

    See more

    Declaration

    Swift

    public protocol DataTransformable
  • Represents a data provider to provide image data to Kingfisher when setting with Source.provider source. Compared to Source.network member, it gives a chance to load some image data in your own way, as long as you can provide the data representation for the image.

    See more

    Declaration

    Swift

    public protocol ImageDataProvider
  • Represents an image resource at a certain url and a given cache key. Kingfisher will use a Resource to download a resource from network and cache it with the cache key when using Source.network as its image setting source.

    See more

    Declaration

    Swift

    public protocol Resource
  • Represents an object type that is compatible with Kingfisher. You can use kf property to get a value in the namespace of Kingfisher.

    See more

    Declaration

    Swift

    public protocol KingfisherCompatible : AnyObject
  • Represents a value type that is compatible with Kingfisher. You can use kf property to get a value in the namespace of Kingfisher.

    See more

    Declaration

    Swift

    public protocol KingfisherCompatibleValue
  • Represents a processor based on a CIImage Filter. It requires a filter to create an ImageProcessor.

    See more

    Declaration

    Swift

    public protocol CIImageProcessor : ImageProcessor
  • An ImageProcessor would be used to convert some downloaded data to an image.

    See more

    Declaration

    Swift

    public protocol ImageProcessor
  • Represents a placeholder type which could be set while loading as well as loading finished without getting an image.

    See more

    Declaration

    Swift

    public protocol Placeholder
  • Protocol indicates that an authentication challenge could be handled.

    See more

    Declaration

    Swift

    public protocol AuthenticationChallengeResponsable : AnyObject
  • Protocol of ImageDownloader. This protocol provides a set of methods which are related to image downloader working stages and rules.

    See more

    Declaration

    Swift

    public protocol ImageDownloaderDelegate : AnyObject
  • An ImageModifier can be used to change properties on an image in between cache serialization and use of the image. The modified returned image will be only used for current rendering purpose, the serialization data will not contain the changes applied by the ImageModifier.

    See more

    Declaration

    Swift

    public protocol ImageModifier
  • Represents and wraps a method for modifying request during an image download request redirection.

    See more

    Declaration

    Swift

    public protocol ImageDownloadRedirectHandler
  • Represents and wraps a method for modifying request before an image download request starts.

    See more

    Declaration

    Swift

    public protocol ImageDownloadRequestModifier
  • Defines a retry strategy can be applied to a .retryStrategy option.

    See more

    Declaration

    Swift

    public protocol RetryStrategy
  • An indicator type which can be used to show the download task is in progress.

    See more

    Declaration

    Swift

    public protocol Indicator