Struct NSHTTPCookieStorage

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

Available on crate feature NSHTTPCookieStorage only.

NSHTTPCookieStorage implements a singleton object (shared instance) which manages the shared cookie store. It has methods to allow clients to set and remove cookies, and get the current set of cookies. It also has convenience methods to parse and generate cookie-related HTTP header fields.

See also Apple’s documentation

Implementations

impl NSHTTPCookieStorage

pub unsafe fn sharedHTTPCookieStorage() -> Retained<NSHTTPCookieStorage>

Get the shared cookie storage in the default location.

Returns: The shared cookie storage

Starting in OS X 10.11, each app has its own sharedHTTPCookieStorage singleton, which will not be shared with other applications.

pub unsafe fn sharedCookieStorageForGroupContainerIdentifier( identifier: &NSString, ) -> Retained<NSHTTPCookieStorage>

Available on crate feature NSString only.

Get the cookie storage for the container associated with the specified application group identifier

Parameter identifier: The application group identifier

Returns: A cookie storage with a persistent store in the application group container

By default, applications and associated app extensions have different data containers, which means that the sharedHTTPCookieStorage singleton will refer to different persistent cookie stores in an application and any app extensions that it contains. This method allows clients to create a persistent cookie storage that can be shared among all applications and extensions with access to the same application group. Subsequent calls to this method with the same identifier will return the same cookie storage instance.

pub unsafe fn cookies(&self) -> Option<Retained<NSArray<NSHTTPCookie>>>

Available on crate features NSArray and NSHTTPCookie only.

Get all the cookies

Returns: An NSArray of NSHTTPCookies

pub unsafe fn setCookie(&self, cookie: &NSHTTPCookie)

Available on crate feature NSHTTPCookie only.

Set a cookie

The cookie will override an existing cookie with the same name, domain and path, if any.

pub unsafe fn deleteCookie(&self, cookie: &NSHTTPCookie)

Available on crate feature NSHTTPCookie only.

Delete the specified cookie

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

Available on crate feature NSDate only.

Delete all cookies from the cookie storage since the provided date.

pub unsafe fn cookiesForURL( &self, url: &NSURL, ) -> Option<Retained<NSArray<NSHTTPCookie>>>

Available on crate features NSArray and NSHTTPCookie and NSURL only.

Returns an array of cookies to send to the given URL.

Parameter URL: The URL for which to get cookies.

Returns: an NSArray of NSHTTPCookie objects.

The cookie manager examines the cookies it stores and includes those which should be sent to the given URL. You can use +[NSCookie requestHeaderFieldsWithCookies:] to turn this array into a set of header fields to add to a request.

pub unsafe fn setCookies_forURL_mainDocumentURL( &self, cookies: &NSArray<NSHTTPCookie>, url: Option<&NSURL>, main_document_url: Option<&NSURL>, )

Available on crate features NSArray and NSHTTPCookie and NSURL only.

Adds an array cookies to the cookie store, following the cookie accept policy.

Parameter cookies: The cookies to set.

Parameter URL: The URL from which the cookies were sent.

Parameter mainDocumentURL: The main document URL to be used as a base for the “same domain as main document” policy.

For mainDocumentURL, the caller should pass the URL for an appropriate main document, if known. For example, when loading a web page, the URL of the main html document for the top-level frame should be passed. To save cookies based on a set of response headers, you can use +[NSCookie cookiesWithResponseHeaderFields:forURL:] on a header field dictionary and then use this method to store the resulting cookies in accordance with policy settings.

pub unsafe fn cookieAcceptPolicy(&self) -> NSHTTPCookieAcceptPolicy

The cookie accept policy preference of the receiver.

pub unsafe fn setCookieAcceptPolicy( &self, cookie_accept_policy: NSHTTPCookieAcceptPolicy, )

Setter for cookieAcceptPolicy.

pub unsafe fn sortedCookiesUsingDescriptors( &self, sort_order: &NSArray<NSSortDescriptor>, ) -> Retained<NSArray<NSHTTPCookie>>

Available on crate features NSArray and NSHTTPCookie and NSSortDescriptor only.

Returns an array of all cookies in the store, sorted according to the key value and sorting direction of the NSSortDescriptors specified in the parameter.

Parameter sortOrder: an array of NSSortDescriptors which represent the preferred sort order of the resulting array.

proper sorting of cookies may require extensive string conversion, which can be avoided by allowing the system to perform the sorting. This API is to be preferred over the more generic -[NSHTTPCookieStorage cookies] API, if sorting is going to be performed.

impl NSHTTPCookieStorage

Methods declared on superclass NSObject.

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

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

impl NSHTTPCookieStorage

NSURLSessionTaskAdditions.

pub unsafe fn storeCookies_forTask( &self, cookies: &NSArray<NSHTTPCookie>, task: &NSURLSessionTask, )

Available on crate features NSArray and NSHTTPCookie and NSURLSession only.

pub unsafe fn getCookiesForTask_completionHandler( &self, task: &NSURLSessionTask, completion_handler: &DynBlock<dyn Fn(*mut NSArray<NSHTTPCookie>)>, )

Available on crate features NSArray and NSHTTPCookie and NSURLSession and block2 only.

Methods from Deref<Target = NSObject>

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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());

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.

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`
    }
}

Trait Implementations

impl AsRef<AnyObject> for NSHTTPCookieStorage

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSHTTPCookieStorage> for NSHTTPCookieStorage

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for NSHTTPCookieStorage

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for NSHTTPCookieStorage

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSHTTPCookieStorage

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSHTTPCookieStorage

const NAME: &'static str = "NSHTTPCookieStorage"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSHTTPCookieStorage as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for NSHTTPCookieStorage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for NSHTTPCookieStorage

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for NSHTTPCookieStorage

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for NSHTTPCookieStorage

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSHTTPCookieStorage

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for NSHTTPCookieStorage

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for NSHTTPCookieStorage

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for NSHTTPCookieStorage

impl Eq for NSHTTPCookieStorage

impl Send for NSHTTPCookieStorage

impl Sync for NSHTTPCookieStorage