NEW: Nominations are now open for the 2019 Swift Community Awards! >>

How to compress and decompress data

Swift version: 5.1

Paul Hudson    @twostraws   

Apple gives us dedicated API for compressing binary data, although annoyingly it exists on NSData without being bridged neatly to Swift’s native Data type. Fortunately, that conversion is trivial, so this functionality isn’t hard to use.

Here’s how to use it:

do {
    let compressedData = try (yourData as NSData).compressed(using: .lzfse)
    // use your compressed data
} catch {
    print(error.localizedDescription)
}

Although it’s common for folks to call compression and decompression zipping and unzipping, zip is one particular file format and the code above uses the LZFSE compression algorithm instead. This an Apple-design compression algorithm that is recommended unless you specifically need one of the others. The alternatives are:

  • .lz4 compresses less effectively, but is significantly faster.
  • .zlib is the recommended general purpose algorithm to use if you want cross compatibility with non-Apple devices.
  • .lzma compresses the most effectively, but should only be used if memory usage and speed are not important. Apple specifically states that this might use a large amount of memory, and so it should be avoided if you’re trying to compress large amounts of data. This is about 10x slower than the alternatives.

If you want to decompress some data, you should use the counterpart method, decompressed(using:), which works in the same way.

SAVE 20% ON iOS CONF SG The largest iOS conference in Southeast Asia is back in Singapore for the 5th time in January 2020, now with two days of workshops plus two days of talks on SwiftUI, Combine, GraphQL, and more! Save a massive 20% on your tickets by clicking on this link.

Available from iOS 13.0

Similar solutions…

About the Swift Knowledge Base

This is part of the Swift Knowledge Base, a free, searchable collection of solutions for common iOS questions.

MASTER SWIFT NOW
Buy Testing Swift Buy Practical iOS 12 Buy Pro Swift Buy Swift Design Patterns Buy Swift Coding Challenges Buy Server-Side Swift (Vapor Edition) Buy Server-Side Swift (Kitura Edition) Buy Hacking with macOS Buy Advanced iOS Volume One Buy Advanced iOS Volume Two Buy Hacking with watchOS Buy Hacking with tvOS Buy Hacking with Swift Buy Dive Into SpriteKit Buy Swift in Sixty Seconds Buy Objective-C for Swift Developers Buy Beyond Code

Was this page useful? Let us know!