Nuke Documentation

Classes

Data​Cache

An LRU disk cache that stores data in separate files.

Data​Loader

Provides basic networking using URLSession.

Image​Cache

An LRU memory cache.

Image​Decoders.​Default

A decoder that supports all of the formats natively supported by the system.

Image​Decoder​Registry

A registry of image codecs.

Image​Pipeline

ImagePipeline is the primary way to load images directly (without a UI).

Image​Prefetcher

Prefetches and caches images to eliminate delays when requesting the same images later.

Image​Task

A task performed by the ImagePipeline.

Fetch​Image

An observable object that simplifies image loading in SwiftUI.

Structures

Image​Publisher

A publisher that starts a new ImageTask when a subscriber is added.

Image​Cache​Key

An opaque container that acts as a cache key.

Image​Decoders.​Empty

A decoder that returns an empty placeholder image and attaches image data to the image container.

Image​Decoding​Context

Image decoding context used when selecting which decoder to use.

Image​Type

A uniform type identifier (UTI).

Image​Encoding​Context

Image encoding context used when selecting which encoder to use.

Image​Encoders.​Default

A default adaptive encoder which uses best encoder available depending on the input image and its configuration.

Image​Encoders.​Image​IO

An Image I/O based encoder.

Image​Pipeline.​Cache

Provides a set of convenience APIs for managing the pipeline cache layers, including ImageCaching (memory cache) and DataCaching (disk cache).

Image​Pipeline.​Cache.​Caches

Describes a set of cache layers to use.

Image​Pipeline.​Configuration

The pipeline configuration.

Image​Processing​Context

Image processing context used when selecting which processor to use.

Image​Processors.​Resize

Scales an image to a specified size.

Image​Processors.​Circle

Rounds the corners of an image into a circle. If the image is not a square, crops it to a square first.

Image​Processors.​Rounded​Corners

Rounds the corners of an image to the specified radius.

Image​Processors.​Core​Image​Filter

Applies Core Image filter (CIFilter) to the image.

Image​Processors.​Gaussian​Blur

Blurs an image using CIGaussianBlur filter.

Image​Processors.​Composition

Composes multiple processors.

Image​Processors.​Anonymous

Processed an image using a specified closure.

Image​Processing​Options.​Border

Draws a border.

Image​Request

Represents an image request.

Image​Request.​User​Info​Key

A key use in userInfo.

Image​Request.​Options

Image request options.

Image​Response

An image response that contains a fetched image and some metadata.

Image​Container

An image container with an image and associated metadata.

Image​Container.​User​Info​Key

A key use in userInfo.

Fetch​Image.​Progress

The download progress.

Image​Loading​Options

A set of options that control how the image is loaded and displayed.

Image​Loading​Options.​Content​Modes

Custom content modes to be used for each image type (placeholder, success, failure).

Image​Loading​Options.​Tint​Colors

Custom tint color to be used for each image type (placeholder, success, failure).

Image​Loading​Options.​Transition

An animated image transition.

Enumerations

Data​Loader.​Error

Errors produced by DataLoader.

Data​Task​Event

An event send by the data loader.

Image​Decoders

A namespace with all available decoders.

Image​Encoders

A namespace with all available encoders.

Image​Pipeline.​Error

Represents all possible image pipeline errors.

Image​Pipeline.​Configuration.​Data​Cache​Policy

Determines what images are stored in the disk cache.

Image​Task​Event

An image task event sent by the pipeline.

Image​Prefetcher.​Destination

Prefetching destination.

Image​Processors

A namespace for all processors that implement ImageProcessing protocol.

Image​Processors.​Resize.​Content​Mode

An option for how to resize the image.

Image​Processing​Options

A namespace with shared image processing options.

Image​Processing​Options.​Unit
Image​Request.​Priority

The priority affecting the order in which the requests are performed.

Image​Response.​Cache​Type

A cache type.

Fetch​Image​Error

Protocols

Data​Caching

Data cache.

Cancellable

A unit of work that can be cancelled.

Data​Loading

Fetches original image data.

Data​Loader​Observing

Allows you to tap into internal events of the data loader. Events are delivered on the internal serial operation queue.

Image​Caching

In-memory image cache.

Image​Decoding

An image decoder.

Image​Decoder​Registering

An image decoder which supports automatically registering in the decoder register.

Image​Encoding

An image encoder.

Image​Pipeline​Delegate

A delegate that allows you to customize the pipleine on a per-request basis.

Image​Processing

Performs image processing.

Image​Request​Convertible

Represents a type that can be converted to an ImageRequest.

Nuke_Image​Displaying

Displays images. Add the conformance to this protocol to your views to make them compatible with Nuke image loading extensions.

Typealiases

Platform​Image

Alias for UIImage.

Platform​Image

Alias for NSImage.

Image​Displaying​View

A UIView that implements ImageDisplaying protocol.

Image​Displaying​View

An NSObject that implements ImageDisplaying and Animating protocols. Can support NSView and NSCell. The latter can return nil for layer.

Image​Displaying​View

A WKInterfaceObject that implements ImageDisplaying protocol.

Functions

load​Image(with:​options:​into:​completion:​)

Loads an image with the given request and displays it in the view.

load​Image(with:​options:​into:​progress:​completion:​)

Loads an image with the given request and displays it in the view.

cancel​Request(for:​)

Cancels an outstanding request associated with the view.

Extensions

Optional
String
URL
URLRequest