PINCache
Fast, non-deadlocking parallel object cache for iOS and OS X.
PINCache is a fork of TMCache re-architected to fix issues with deadlocking caused by heavy use. It is a key/value store designed for persisting temporary objects that are expensive to reproduce, such as downloaded data or the results of slow processing. It is comprised of two self-similar stores, one in memory (PINMemoryCache) and one on disk (PINDiskCache), all backed by GCD and safe to access from multiple threads simultaneously. On iOS, PINMemoryCache will clear itself when the app receives a memory warning or goes into the background. Objects stored in PINDiskCache remain until you trim the cache yourself, either manually or by setting a byte or age limit.
PINCache and PINDiskCache accept any object conforming to NSCoding. Put things in like this:
Objective-C
UIImage *img = [[UIImage alloc] initWithData:data scale:[[UIScreen mainScreen] scale]];
[[PINCache sharedCache] setObject:img forKey:@"image" block:nil]; // returns immediately
Swift
let img = UIImage(data: data, scale:UIScreen.main.scale)
PINCache.shared().setObject(img, forKey: "img")
Get them back out like this:
Objective-C
[[PINCache sharedCache] objectForKeyAsync:@"image" block:^(PINCache *cache, NSString *key, id object) {
UIImage *image = (UIImage *)object;
NSLog(@"image scale: %f", image.scale);
}];
Swift
PINCache.shared().object(forKey: "image") { (cache, key, object) in
if let image = object as? UIImage {
print("image scale: %f", image.scale)
}
}
Both PINMemoryCache and PINDiskCache use locks to protect reads and writes. PINCache coordinates them so that objects added to memory are available immediately to other threads while being written to disk safely in the background. Both caches are public properties of PINCache, so it's easy to manipulate one or the other separately if necessary.
Collections work too. Thanks to the magic of NSKeyedArchiver, objects repeated in a collection only occupy the space of one on disk:
Objective-C
NSArray *images = @[ image, image, image ];
[[PINCache sharedCache] setObject:images forKey:@"images"];
NSLog(@"3 for the price of 1: %d", [[[PINCache sharedCache] diskCache] byteCount]);
Swift
// In Swift, Array, String, and Dictionary are all value types.
let images = [image, image, image] as NSArray // Cast to NSArray
PINCache.shared.setObject(images, forKey: "images")
print("3 for the prices of 1: %d", PINCache.shared.diskCache.byteCount)
Installation
Manually
Download the latest tag and drag the PINCache folder into your Xcode project.
Install the docs by double clicking the .docset file under docs/, or view them online at cocoadocs.org
Git Submodule
git submodule add https://github.com/pinterest/PINCache.git
git submodule update --init
CocoaPods
Add PINCache to your Podfile and run pod install.
Carthage
Add the following line to your Cartfile and run carthage update --platform ios. Then follow this instruction of Carthage to embed the framework.
github "pinterest/PINCache"
Requirements
PINCache requires iOS 8.0, tvOS 9.0, watchOS 2.0 or macOS 10.8 and greater.
Contact
License
Copyright 2013 Tumblr, Inc. Copyright 2015 Pinterest, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
![Crash on -[PINDiskCache objectForKey:fileURL:]](https://avatars.githubusercontent.com/u/4573957?v=4)
![+[PINDiskCache moveItemAtURLToTrash:] (PINDiskCache.m:451) Crashed at -[NSURL fileSystemRepresentation]](https://avatars.githubusercontent.com/u/12739838?v=4)
2.7k Dec 28, 2022
21 Jan 5, 2023
124 Nov 24, 2022
628 Dec 3, 2022
1.2k Dec 28, 2022
122 Dec 28, 2022
268 Nov 21, 2022
487 Jan 5, 2023
3 Aug 28, 2022
5.2k Dec 29, 2022
2.3k Dec 16, 2022
74 Nov 24, 2022
73 Aug 6, 2021
2 Feb 28, 2022
1 Oct 1, 2021
278 Jan 5, 2023
13 Jan 22, 2018