ImageScout

A Swift implementation of fastimage. Supports PNG, GIF, and JPEG.

Code Quality Rank: L4

Programming language: Swift

License: MIT License

Tags: Media     Image    

Latest version: v3.0-beta

README

ImageScout

ImageScout is a Swift implementation of fastimage. It allows you to find the size and type of a remote image by downloading as little as possible.

Why?

Sometimes you need to know the size of a remote image before downloading it, such as using a custom layout in a UICollectionView.

How?

ImageScout parses the image data as it is downloaded. As soon as it finds out the size and type of image, it stops the download. The downloaded data is below 60 KB in most cases.

Install

Swift Package Manager

Add the following to your Package.switft file:

let package = Package(
    dependencies: [
    .package(url: "https://github.com/kaishin/ImageScout.git", from: "2.1.0")
    ],
)

Carthage

• Add the following to your Cartfile: github "kaishin/ImageScout"
• Then run carthage update
• Follow the current instructions in Carthage's README for up to date installation instructions.

CocoaPods

• Add the following to your Podfile: pod 'ImageScout'
• You will also need to make sure you're opting into using frameworks: use_frameworks!
• Then run pod install with CocoaPods 1.0 or newer.

Usage

The only method you will be using is scoutImageWithURI(), with the following full signature:

func scoutImageWithURI(URI: String, completion: (NSError?, CGSize, ScoutedImageType) -> ())

Here's an example:

let scout = ImageScout()

scout.scoutImageWithURI("http://.../image-scout-logo.png") { error, size, type in
  if let error = error {
    print(error.code)
  } else {
    print("Size: \(size)")
    print("Type: \(type.rawValue)")
  }
}

If the image is not successfully parsed, the size is going to be CGSizeZero and the type .Unsupported. The error will contain more info about the reason:

• Error code 100: Invalid URI parameter.
• Error code 101: Image is corrupt or malformatted.
• Error code 102: Not an image or unsopported image format URL.

⚠️ It's important to keep a strong reference to the ImageScout instance until the callback completes. If reference is lost, your completion handler will never be executed.

Compatibility

• Swift 5 / Xcode 11
• iOS 8+
• macOS 10.11

License

See LICENSE.