Struct NSURLProtectionSpace

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

Available on crate feature NSURLProtectionSpace only.

This class represents a protection space requiring authentication.

See also Apple’s documentation

Implementations

impl NSURLProtectionSpace

pub unsafe fn initWithHost_port_protocol_realm_authenticationMethod( this: Allocated<Self>, host: &NSString, port: NSInteger, protocol: Option<&NSString>, realm: Option<&NSString>, authentication_method: Option<&NSString>, ) -> Retained<Self>

Available on crate feature NSString only.

Initialize a protection space representing an origin server, or a realm on one

Parameter host: The hostname of the server

Parameter port: The port for the server

Parameter protocol: The protocol for this server - e.g. “http”, “ftp”, “https”

Parameter realm: A string indicating a protocol-specific subdivision of a single host. For http and https, this maps to the realm string in http authentication challenges. For many other protocols it is unused.

Parameter authenticationMethod: The authentication method to use to access this protection space - valid values include nil (default method), “ digest“ and @“form”.

Returns: The initialized object.

pub unsafe fn initWithProxyHost_port_type_realm_authenticationMethod( this: Allocated<Self>, host: &NSString, port: NSInteger, type: Option<&NSString>, realm: Option<&NSString>, authentication_method: Option<&NSString>, ) -> Retained<Self>

Available on crate feature NSString only.

Initialize a protection space representing a proxy server, or a realm on one

Parameter host: The hostname of the proxy server

Parameter port: The port for the proxy server

Parameter type: The type of proxy - e.g. “http”, “ftp”, “SOCKS”

Parameter realm: A string indicating a protocol-specific subdivision of a single host. For http and https, this maps to the realm string in http authentication challenges. For many other protocols it is unused.

Parameter authenticationMethod: The authentication method to use to access this protection space - valid values include nil (default method) and “ digest“

Returns: The initialized object.

pub unsafe fn realm(&self) -> Option<Retained<NSString>>

Available on crate feature NSString only.

Get the authentication realm for which the protection space that needs authentication

This is generally only available for http authentication, and may be nil otherwise.

Returns: The realm string

pub unsafe fn receivesCredentialSecurely(&self) -> bool

Determine if the password for this protection space can be sent securely

Returns: YES if a secure authentication method or protocol will be used, NO otherwise

pub unsafe fn isProxy(&self) -> bool

Determine if this authenticating protection space is a proxy server

Returns: YES if a proxy, NO otherwise

pub unsafe fn host(&self) -> Retained<NSString>

Available on crate feature NSString only.

Get the proxy host if this is a proxy authentication, or the host from the URL.

Returns: The host for this protection space.

pub unsafe fn port(&self) -> NSInteger

Get the proxy port if this is a proxy authentication, or the port from the URL.

Returns: The port for this protection space, or 0 if not set.

pub unsafe fn proxyType(&self) -> Option<Retained<NSString>>

Available on crate feature NSString only.

Get the type of this protection space, if a proxy

Returns: The type string, or nil if not a proxy.

pub unsafe fn protocol(&self) -> Option<Retained<NSString>>

Available on crate feature NSString only.

Get the protocol of this protection space, if not a proxy

Returns: The type string, or nil if a proxy.

pub unsafe fn authenticationMethod(&self) -> Retained<NSString>

Available on crate feature NSString only.

Get the authentication method to be used for this protection space

Returns: The authentication method

impl NSURLProtectionSpace

Methods declared on superclass NSObject.

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

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

impl NSURLProtectionSpace

NSClientCertificateSpace. This category supplies additional information for use when a client certificate is required by the server in order to complete authentication.

pub unsafe fn distinguishedNames(&self) -> Option<Retained<NSArray<NSData>>>

Available on crate features NSArray and NSData only.

Returns an array of acceptable certificate issuing authorities for client certification authentication. Issuers are identified by their distinguished name and returned as a DER encoded data.

Returns: An array of NSData objects. (Nil if the authenticationMethod is not NSURLAuthenticationMethodClientCertificate)

impl NSURLProtectionSpace

NSServerTrustValidationSpace. This category supplies additional information for use by the client to evaluate whether to trust a given server during a security handshake.

This impl block contains no items.

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 NSURLProtectionSpace

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSURLProtectionSpace

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSURLProtectionSpace> for NSURLProtectionSpace

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSURLProtectionSpace

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSURLProtectionSpace

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSURLProtectionSpace

const NAME: &'static str = "NSURLProtectionSpace"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSURLProtectionSpace 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 CopyingHelper for NSURLProtectionSpace

Available on crate feature NSObject only.

type Result = NSURLProtectionSpace

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for NSURLProtectionSpace

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

Formats the value using the given formatter.

impl Deref for NSURLProtectionSpace

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSURLProtectionSpace

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 NSURLProtectionSpace

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSURLProtectionSpace

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

impl NSCopying for NSURLProtectionSpace

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for NSURLProtectionSpace

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 NSSecureCoding for NSURLProtectionSpace

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

Available on crate feature NSObject only.

impl PartialEq for NSURLProtectionSpace

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 NSURLProtectionSpace

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

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

impl DowncastTarget for NSURLProtectionSpace

impl Eq for NSURLProtectionSpace

impl Send for NSURLProtectionSpace

impl Sync for NSURLProtectionSpace