https://github.com/soffes/cache

Swift caching library
https://github.com/soffes/cache

carthage ios macos swift tvos watchos

Last synced: about 3 hours ago
JSON representation

Swift caching library

• Host: GitHub
• URL: https://github.com/soffes/cache
• Owner: soffes
• License: mit
• Created: 2016-05-12T22:30:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-06-03T17:05:04.000Z (over 4 years ago)
• Last Synced: 2024-08-14T13:17:27.471Z (3 months ago)
• Topics: carthage, ios, macos, swift, tvos, watchos
• Language: Swift
• Size: 34.2 KB
• Stars: 213
• Watchers: 6
• Forks: 17
• Open Issues: 1
• Metadata Files:
  • Readme: Readme.markdown
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cache

[![Version](https://img.shields.io/github/release/soffes/Cache.svg)](https://github.com/soffes/Cache/releases)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

A generic caching library for Swift. Cache depends on Foundation.

This is still very much a work in progress.

## Usage

Cache provides a simple `Cache` protocol:

```swift

protocol Cache {

  associatedtype Element

  func get(key key: String, completion: (Element? -> Void))

  func set(key key: String, value: Element, completion: (() -> Void)?)

  func remove(key key: String, completion: (() -> Void)?)

  func removeAll(completion completion: (() -> Void)?)

}

```

There are two (well actually three, but we'll get there) provided caches:

* `MemoryCache` — Backed by an `NSCache`

* `DiskCache` — Backed by files on disk using `NSFileManager`

Using both of these is exactly the same interface.

## MultiCache

There is a third cache provided called `MultiCache`. This combines caches.

```swift

let cache = MultiCache(caches: [memoryCache, diskCache])

cache.set(key: "foo", value: "bar")

```

This will write to all caches in parallel. When accessing the multi cache, it will go in order. In this example, it will try the memory cache and if there's a miss it will try the disk cache. If it were to find it in the disk cache, it will write it to all previous caches for faster future reads.

## Thanks

Thanks to [Caleb Davenport](https://twitter.com/calebd) for unintentionally inspiring this and lots of help along the way.