Close Menu

pantry

Pantry Documentation

Welcome to the documentation for Pantry, a versatile and efficient storage solution for your iOS applications. Whether you need to cache data, store preferences, or manage temporary files, Pantry has you covered.

Table of Contents

Installation

To install Pantry in your iOS project, follow these steps:

  1. Ensure you have CocoaPods installed.
  2. Add Pantry to your Podfile: pod 'Pantry'
  3. Run pod install in your project’s directory.
  4. Import Pantry into your Swift file: import Pantry

Usage

Pantry provides a simple and intuitive interface for managing your data.

1. Caching

Pantry allows you to easily cache data from your network requests or expensive computations to improve performance:

// Storing data
try? Pantry.pack(objectToCache, key: "uniqueCacheKey")
// Retrieving data
let cachedObject = try? Pantry.unpack("uniqueCacheKey")

2. Preferences

Store and retrieve application preferences efficiently using Pantry:

// Storing preferences
try? Pantry.pack(preferences, key: "uniquePreferencesKey")
// Retrieving preferences
let retrievedPreferences = try? Pantry.unpack("uniquePreferencesKey")

3. Temporary Files

Pantry allows you to manage temporary files easily:

// Storing temporary file
try? Pantry.pack(temporaryFile, key: "uniqueTemporaryFileKey")
// Retrieving temporary file
let retrievedTemporaryFile = try? Pantry.unpack("uniqueTemporaryFileKey")

Error Handling

When using Pantry, it is important to handle potential errors appropriately. Pantry provides robust error handling:

do {
    let object = try Pantry.unpack("key")
    // Handle successful unpacking here
} catch PantryError.cachedObjectNotFound {
    // Handle object not found error
} catch let error {
    // Handle other potential errors here
}

That’s it! You’re now equipped with the knowledge to utilize Pantry effectively in your iOS applications. Happy coding!