Struct NSURLAuthenticationChallenge

Source

pub struct NSURLAuthenticationChallenge { /* private fields */ }

Available on crate feature NSURLAuthenticationChallenge only.

Expand description

This class represents an authentication challenge. It provides all the information about the challenge, and has a method to indicate when it’s done.

Implementations§

Source §

impl NSURLAuthenticationChallenge

Source

pub fn initWithProtectionSpace_proposedCredential_previousFailureCount_failureResponse_error_sender( this: Allocated<Self>, space: &NSURLProtectionSpace, credential: Option<&NSURLCredential>, previous_failure_count: NSInteger, response: Option<&NSURLResponse>, error: Option<&NSError>, sender: &ProtocolObject<dyn NSURLAuthenticationChallengeSender>, ) -> Retained<Self>

Available on crate features NSError and NSURLCredential and NSURLProtectionSpace and NSURLResponse only.

Initialize an authentication challenge

Parameter space: The NSURLProtectionSpace to use

Parameter credential: The proposed NSURLCredential for this challenge, or nil

Parameter previousFailureCount: A count of previous failures attempting access.

Parameter response: The NSURLResponse for the authentication failure, if applicable, else nil

Parameter error: The NSError for the authentication failure, if applicable, else nil

Returns: An authentication challenge initialized with the specified parameters

Source

pub fn initWithAuthenticationChallenge_sender( this: Allocated<Self>, challenge: &NSURLAuthenticationChallenge, sender: &ProtocolObject<dyn NSURLAuthenticationChallengeSender>, ) -> Retained<Self>

Initialize an authentication challenge copying all parameters from another one.

Returns: A new challenge initialized with the parameters from the passed in challenge

This initializer may be useful to subclassers that want to proxy one type of authentication challenge to look like another type.

Source

pub fn protectionSpace(&self) -> Retained<NSURLProtectionSpace>

Available on crate feature NSURLProtectionSpace only.

Get a description of the protection space that requires authentication

Returns: The protection space that needs authentication

Source

pub fn proposedCredential(&self) -> Option<Retained<NSURLCredential>>

Available on crate feature NSURLCredential only.

Get the proposed credential for this challenge

Returns: The proposed credential

proposedCredential may be nil, if there is no default credential to use for this challenge (either stored or in the URL). If the credential is not nil and returns YES for hasPassword, this means the NSURLConnection thinks the credential is ready to use as-is. If it returns NO for hasPassword, then the credential is not ready to use as-is, but provides a default username the client could use when prompting.

Source

pub fn previousFailureCount(&self) -> NSInteger

Get count of previous failed authentication attempts

Returns: The count of previous failures

Source

pub fn failureResponse(&self) -> Option<Retained<NSURLResponse>>

Available on crate feature NSURLResponse only.

Get the response representing authentication failure.

Returns: The failure response or nil

If there was a previous authentication failure, and this protocol uses responses to indicate authentication failure, then this method will return the response. Otherwise it will return nil.

Source

pub fn error(&self) -> Option<Retained<NSError>>

Available on crate feature NSError only.

Get the error representing authentication failure.

If there was a previous authentication failure, and this protocol uses errors to indicate authentication failure, then this method will return the error. Otherwise it will return nil.

Source

pub fn sender( &self, ) -> Option<Retained<ProtocolObject<dyn NSURLAuthenticationChallengeSender>>>

Get the sender of this challenge

Returns: The sender of the challenge

The sender is the object you should reply to when done processing the challenge.

Source §

impl NSURLAuthenticationChallenge

Methods declared on superclass NSObject.

Source

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

Source

pub fn new() -> Retained<Self>

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