Struct NSURLCache

Source

#[repr(C)]
pub struct NSURLCache { /* private fields */ }

Available on crate feature NSURLCache only.

Expand description

Apple’s documentation

Implementations§

Source §

impl NSURLCache

Source

pub unsafe fn sharedURLCache() -> Retained<NSURLCache>

Returns the shared NSURLCache instance or sets the NSURLCache instance shared by all clients of the current process. This will be the new object returned when calls to the sharedURLCache method are made.

Unless set explicitly through a call to +setSharedURLCache: , this method returns an NSURLCache instance created with the following default values:

Memory capacity: 4 megabytes (4 * 1024 * 1024 bytes)
Disk capacity: 20 megabytes (20 * 1024 * 1024 bytes)
Disk path: (user home directory)/Library/Caches/(application bundle id)

Users who do not have special caching requirements or constraints should find the default shared cache instance acceptable. If this default shared cache instance is not acceptable, +setSharedURLCache: can be called to set a different NSURLCache instance to be returned from this method. Callers should take care to ensure that the setter is called at a time when no other caller has a reference to the previously-set shared URL cache. This is to prevent storing cache data from becoming unexpectedly unretrievable.

Returns: the shared NSURLCache instance.

Source

pub unsafe fn setSharedURLCache(shared_url_cache: &NSURLCache)

Setter for sharedURLCache.

Source

pub unsafe fn initWithMemoryCapacity_diskCapacity_diskPath( this: Allocated<Self>, memory_capacity: NSUInteger, disk_capacity: NSUInteger, path: Option<&NSString>, ) -> Retained<Self>

👎Deprecated

Available on crate feature NSString only.

Initializes an NSURLCache with the given capacity and path.

The returned NSURLCache is backed by disk, so developers can be more liberal with space when choosing the capacity for this kind of cache. A disk cache measured in the tens of megabytes should be acceptable in most cases.

Parameter memoryCapacity: the capacity, measured in bytes, for the cache in memory.

Parameter diskCapacity: the capacity, measured in bytes, for the cache on disk.

Parameter path: the path on disk where the cache data is stored.

Returns: an initialized NSURLCache, with the given capacity, backed by disk.

Source

pub unsafe fn initWithMemoryCapacity_diskCapacity_directoryURL( this: Allocated<Self>, memory_capacity: NSUInteger, disk_capacity: NSUInteger, directory_url: Option<&NSURL>, ) -> Retained<Self>

Available on crate feature NSURL only.

Initializes an NSURLCache with the given capacity and directory.

Parameter memoryCapacity: the capacity, measured in bytes, for the cache in memory. Or 0 to disable memory cache.

Parameter diskCapacity: the capacity, measured in bytes, for the cache on disk. Or 0 to disable disk cache.

Parameter directoryURL: the path to a directory on disk where the cache data is stored. Or nil for default directory.

Returns: an initialized NSURLCache, with the given capacity, optionally backed by disk.

Source

pub unsafe fn cachedResponseForRequest( &self, request: &NSURLRequest, ) -> Option<Retained<NSCachedURLResponse>>

Available on crate feature NSURLRequest only.

Returns the NSCachedURLResponse stored in the cache with the given request.

The method returns nil if there is no NSCachedURLResponse stored using the given request.

Parameter request: the NSURLRequest to use as a key for the lookup.

Returns: The NSCachedURLResponse stored in the cache with the given request, or nil if there is no NSCachedURLResponse stored with the given request.

Source

pub unsafe fn storeCachedResponse_forRequest( &self, cached_response: &NSCachedURLResponse, request: &NSURLRequest, )

Available on crate feature NSURLRequest only.

Stores the given NSCachedURLResponse in the cache using the given request.

Parameter cachedResponse: The cached response to store.

Parameter request: the NSURLRequest to use as a key for the storage.

Source

pub unsafe fn removeCachedResponseForRequest(&self, request: &NSURLRequest)

Available on crate feature NSURLRequest only.

Removes the NSCachedURLResponse from the cache that is stored using the given request.

No action is taken if there is no NSCachedURLResponse stored with the given request.

Parameter request: the NSURLRequest to use as a key for the lookup.

Source

pub unsafe fn removeAllCachedResponses(&self)

Clears the given cache, removing all NSCachedURLResponse objects that it stores.

Source

pub unsafe fn removeCachedResponsesSinceDate(&self, date: &NSDate)

Available on crate feature NSDate only.

Clears the given cache of any cached responses since the provided date.

Source

pub unsafe fn memoryCapacity(&self) -> NSUInteger

In-memory capacity of the receiver.

At the time this call is made, the in-memory cache will truncate its contents to the size given, if necessary.

Returns: The in-memory capacity, measured in bytes, for the receiver.

Source

pub unsafe fn setMemoryCapacity(&self, memory_capacity: NSUInteger)

Setter for memoryCapacity.

Source

pub unsafe fn diskCapacity(&self) -> NSUInteger

The on-disk capacity of the receiver.

The on-disk capacity, measured in bytes, for the receiver. On mutation the on-disk cache will truncate its contents to the size given, if necessary.

Source

pub unsafe fn setDiskCapacity(&self, disk_capacity: NSUInteger)

Setter for diskCapacity.

Source

pub unsafe fn currentMemoryUsage(&self) -> NSUInteger

Returns the current amount of space consumed by the in-memory cache of the receiver.

This size, measured in bytes, indicates the current usage of the in-memory cache.

Returns: the current usage of the in-memory cache of the receiver.

Source

pub unsafe fn currentDiskUsage(&self) -> NSUInteger

Returns the current amount of space consumed by the on-disk cache of the receiver.

This size, measured in bytes, indicates the current usage of the on-disk cache.

Returns: the current usage of the on-disk cache of the receiver.

Source §

impl NSURLCache

Methods declared on superclass NSObject.

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub unsafe fn new() -> Retained<Self>

Source §

impl NSURLCache

NSURLSessionTaskAdditions.

Source

pub unsafe fn storeCachedResponse_forDataTask( &self, cached_response: &NSCachedURLResponse, data_task: &NSURLSessionDataTask, )

Available on crate feature NSURLSession only.

Source

pub unsafe fn getCachedResponseForDataTask_completionHandler( &self, data_task: &NSURLSessionDataTask, completion_handler: &DynBlock<dyn Fn(*mut NSCachedURLResponse)>, )

Available on crate features NSURLSession and block2 only.

Source

pub unsafe fn removeCachedResponseForDataTask( &self, data_task: &NSURLSessionDataTask, )

Available on crate feature NSURLSession only.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}