Struct NSURLCredentialStorage

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

Available on crate feature NSURLCredentialStorage only.

NSURLCredentialStorage implements a singleton object (shared instance) which manages the shared credentials cache. Note: Whereas in Mac OS X any application can access any credential with a persistence of NSURLCredentialPersistencePermanent provided the user gives permission, in iPhone OS an application can access only its own credentials.

See also Apple’s documentation

Implementations

impl NSURLCredentialStorage

pub unsafe fn sharedCredentialStorage() -> Retained<NSURLCredentialStorage>

Get the shared singleton authentication storage

Returns: the shared authentication storage

pub unsafe fn credentialsForProtectionSpace( &self, space: &NSURLProtectionSpace, ) -> Option<Retained<NSDictionary<NSString, NSURLCredential>>>

Available on crate features NSDictionary and NSString and NSURLCredential and NSURLProtectionSpace only.

Get a dictionary mapping usernames to credentials for the specified protection space.

Parameter space: An NSURLProtectionSpace indicating the protection space for which to get credentials

Returns: A dictionary where the keys are usernames and the values are the corresponding NSURLCredentials.

pub unsafe fn allCredentials( &self, ) -> Retained<NSDictionary<NSURLProtectionSpace, NSDictionary<NSString, NSURLCredential>>>

Available on crate features NSDictionary and NSString and NSURLCredential and NSURLProtectionSpace only.

Get a dictionary mapping NSURLProtectionSpaces to dictionaries which map usernames to NSURLCredentials

Returns: an NSDictionary where the keys are NSURLProtectionSpaces and the values are dictionaries, in which the keys are usernames and the values are NSURLCredentials

pub unsafe fn setCredential_forProtectionSpace( &self, credential: &NSURLCredential, space: &NSURLProtectionSpace, )

Available on crate features NSURLCredential and NSURLProtectionSpace only.

Add a new credential to the set for the specified protection space or replace an existing one.

Parameter credential: The credential to set.

Parameter space: The protection space for which to add it.

Multiple credentials may be set for a given protection space, but each must have a distinct user. If a credential with the same user is already set for the protection space, the new one will replace it.

pub unsafe fn removeCredential_forProtectionSpace( &self, credential: &NSURLCredential, space: &NSURLProtectionSpace, )

Available on crate features NSURLCredential and NSURLProtectionSpace only.

Remove the credential from the set for the specified protection space.

Parameter credential: The credential to remove.

Parameter space: The protection space for which a credential should be removed

The credential is removed from both persistent and temporary storage. A credential that has a persistence policy of NSURLCredentialPersistenceSynchronizable will fail. See removeCredential:forProtectionSpace:options.

pub unsafe fn removeCredential_forProtectionSpace_options( &self, credential: &NSURLCredential, space: &NSURLProtectionSpace, options: Option<&NSDictionary<NSString, AnyObject>>, )

Available on crate features NSDictionary and NSString and NSURLCredential and NSURLProtectionSpace only.

Remove the credential from the set for the specified protection space based on options.

Parameter credential: The credential to remove.

Parameter space: The protection space for which a credential should be removed

Parameter options: A dictionary containing options to consider when removing the credential. This should be used when trying to delete a credential that has the NSURLCredentialPersistenceSynchronizable policy. Please note that when NSURLCredential objects that have a NSURLCredentialPersistenceSynchronizable policy are removed, the credential will be removed on all devices that contain this credential.

The credential is removed from both persistent and temporary storage.

pub unsafe fn defaultCredentialForProtectionSpace( &self, space: &NSURLProtectionSpace, ) -> Option<Retained<NSURLCredential>>

Available on crate features NSURLCredential and NSURLProtectionSpace only.

Get the default credential for the specified protection space.

Parameter space: The protection space for which to get the default credential.

pub unsafe fn setDefaultCredential_forProtectionSpace( &self, credential: &NSURLCredential, space: &NSURLProtectionSpace, )

Available on crate features NSURLCredential and NSURLProtectionSpace only.

Set the default credential for the specified protection space.

Parameter credential: The credential to set as default.

Parameter space: The protection space for which the credential should be set as default.

If the credential is not yet in the set for the protection space, it will be added to it.

impl NSURLCredentialStorage

Methods declared on superclass NSObject.

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

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

impl NSURLCredentialStorage

NSURLSessionTaskAdditions.

pub unsafe fn getCredentialsForProtectionSpace_task_completionHandler( &self, protection_space: &NSURLProtectionSpace, task: &NSURLSessionTask, completion_handler: &DynBlock<dyn Fn(*mut NSDictionary<NSString, NSURLCredential>)>, )

Available on crate features NSDictionary and NSString and NSURLCredential and NSURLProtectionSpace and NSURLSession and block2 only.

pub unsafe fn setCredential_forProtectionSpace_task( &self, credential: &NSURLCredential, protection_space: &NSURLProtectionSpace, task: &NSURLSessionTask, )

Available on crate features NSURLCredential and NSURLProtectionSpace and NSURLSession only.

pub unsafe fn removeCredential_forProtectionSpace_options_task( &self, credential: &NSURLCredential, protection_space: &NSURLProtectionSpace, options: Option<&NSDictionary<NSString, AnyObject>>, task: &NSURLSessionTask, )

Available on crate features NSDictionary and NSString and NSURLCredential and NSURLProtectionSpace and NSURLSession only.

pub unsafe fn getDefaultCredentialForProtectionSpace_task_completionHandler( &self, space: &NSURLProtectionSpace, task: &NSURLSessionTask, completion_handler: &DynBlock<dyn Fn(*mut NSURLCredential)>, )

Available on crate features NSURLCredential and NSURLProtectionSpace and NSURLSession and block2 only.

pub unsafe fn setDefaultCredential_forProtectionSpace_task( &self, credential: &NSURLCredential, protection_space: &NSURLProtectionSpace, task: &NSURLSessionTask, )

Available on crate features NSURLCredential and NSURLProtectionSpace and NSURLSession 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 NSURLCredentialStorage

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSURLCredentialStorage

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSURLCredentialStorage> for NSURLCredentialStorage

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSURLCredentialStorage

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSURLCredentialStorage

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSURLCredentialStorage

const NAME: &'static str = "NSURLCredentialStorage"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSURLCredentialStorage 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 NSURLCredentialStorage

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

Formats the value using the given formatter.

impl Deref for NSURLCredentialStorage

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSURLCredentialStorage

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 NSURLCredentialStorage

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSURLCredentialStorage

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 NSURLCredentialStorage

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 NSURLCredentialStorage

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

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

impl DowncastTarget for NSURLCredentialStorage

impl Eq for NSURLCredentialStorage

impl Send for NSURLCredentialStorage

impl Sync for NSURLCredentialStorage