Struct NSURLSessionConfiguration 

pub struct NSURLSessionConfiguration { /* private fields */ }

Available on crate feature NSURLSession only.

Apple’s documentation

Implementations

impl NSURLSessionConfiguration

pub fn defaultSessionConfiguration() -> Retained<NSURLSessionConfiguration>

pub fn ephemeralSessionConfiguration() -> Retained<NSURLSessionConfiguration>

pub fn backgroundSessionConfigurationWithIdentifier( identifier: &NSString, ) -> Retained<NSURLSessionConfiguration>

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub fn requestCachePolicy(&self) -> NSURLRequestCachePolicy

Available on crate feature NSURLRequest only.

pub fn setRequestCachePolicy( &self, request_cache_policy: NSURLRequestCachePolicy, )

Available on crate feature NSURLRequest only.

Setter for requestCachePolicy.

pub fn timeoutIntervalForRequest(&self) -> NSTimeInterval

Available on crate feature NSDate only.

pub fn setTimeoutIntervalForRequest( &self, timeout_interval_for_request: NSTimeInterval, )

Available on crate feature NSDate only.

Setter for timeoutIntervalForRequest.

pub fn timeoutIntervalForResource(&self) -> NSTimeInterval

Available on crate feature NSDate only.

pub fn setTimeoutIntervalForResource( &self, timeout_interval_for_resource: NSTimeInterval, )

Available on crate feature NSDate only.

Setter for timeoutIntervalForResource.

pub fn networkServiceType(&self) -> NSURLRequestNetworkServiceType

Available on crate feature NSURLRequest only.

pub fn setNetworkServiceType( &self, network_service_type: NSURLRequestNetworkServiceType, )

Available on crate feature NSURLRequest only.

Setter for networkServiceType.

pub fn allowsCellularAccess(&self) -> bool

pub fn setAllowsCellularAccess(&self, allows_cellular_access: bool)

Setter for allowsCellularAccess.

pub fn allowsExpensiveNetworkAccess(&self) -> bool

pub fn setAllowsExpensiveNetworkAccess( &self, allows_expensive_network_access: bool, )

Setter for allowsExpensiveNetworkAccess.

pub fn allowsConstrainedNetworkAccess(&self) -> bool

pub fn setAllowsConstrainedNetworkAccess( &self, allows_constrained_network_access: bool, )

Setter for allowsConstrainedNetworkAccess.

pub fn requiresDNSSECValidation(&self) -> bool

pub fn setRequiresDNSSECValidation(&self, requires_dnssec_validation: bool)

Setter for requiresDNSSECValidation.

pub fn waitsForConnectivity(&self) -> bool

pub fn setWaitsForConnectivity(&self, waits_for_connectivity: bool)

Setter for waitsForConnectivity.

pub fn isDiscretionary(&self) -> bool

pub fn setDiscretionary(&self, discretionary: bool)

Setter for isDiscretionary.

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

Available on crate feature NSString only.

pub fn setSharedContainerIdentifier( &self, shared_container_identifier: Option<&NSString>, )

Available on crate feature NSString only.

Setter for sharedContainerIdentifier.

This is copied when set.

pub fn sessionSendsLaunchEvents(&self) -> bool

pub fn setSessionSendsLaunchEvents(&self, session_sends_launch_events: bool)

Setter for sessionSendsLaunchEvents.

pub fn connectionProxyDictionary(&self) -> Option<Retained<NSDictionary>>

Available on crate feature NSDictionary only.

pub unsafe fn setConnectionProxyDictionary( &self, connection_proxy_dictionary: Option<&NSDictionary>, )

Available on crate feature NSDictionary only.

Setter for connectionProxyDictionary.

This is copied when set.

Safety

connection_proxy_dictionary generic should be of the correct type.

pub fn HTTPShouldUsePipelining(&self) -> bool

👎Deprecated: Only supported in the classic loader, please adopt HTTP/2 and HTTP/3 instead

pub fn setHTTPShouldUsePipelining(&self, http_should_use_pipelining: bool)

👎Deprecated: Only supported in the classic loader, please adopt HTTP/2 and HTTP/3 instead

Setter for HTTPShouldUsePipelining.

pub fn HTTPShouldSetCookies(&self) -> bool

pub fn setHTTPShouldSetCookies(&self, http_should_set_cookies: bool)

Setter for HTTPShouldSetCookies.

pub fn HTTPCookieAcceptPolicy(&self) -> NSHTTPCookieAcceptPolicy

Available on crate feature NSHTTPCookieStorage only.

pub fn setHTTPCookieAcceptPolicy( &self, http_cookie_accept_policy: NSHTTPCookieAcceptPolicy, )

Available on crate feature NSHTTPCookieStorage only.

Setter for HTTPCookieAcceptPolicy.

pub fn HTTPAdditionalHeaders(&self) -> Option<Retained<NSDictionary>>

Available on crate feature NSDictionary only.

pub unsafe fn setHTTPAdditionalHeaders( &self, http_additional_headers: Option<&NSDictionary>, )

Available on crate feature NSDictionary only.

Setter for HTTPAdditionalHeaders.

This is copied when set.

Safety

http_additional_headers generic should be of the correct type.

pub fn HTTPMaximumConnectionsPerHost(&self) -> NSInteger

pub fn setHTTPMaximumConnectionsPerHost( &self, http_maximum_connections_per_host: NSInteger, )

Setter for HTTPMaximumConnectionsPerHost.

pub fn HTTPCookieStorage(&self) -> Option<Retained<NSHTTPCookieStorage>>

Available on crate feature NSHTTPCookieStorage only.

pub fn setHTTPCookieStorage( &self, http_cookie_storage: Option<&NSHTTPCookieStorage>, )

Available on crate feature NSHTTPCookieStorage only.

Setter for HTTPCookieStorage.

pub fn URLCredentialStorage(&self) -> Option<Retained<NSURLCredentialStorage>>

Available on crate feature NSURLCredentialStorage only.

pub fn setURLCredentialStorage( &self, url_credential_storage: Option<&NSURLCredentialStorage>, )

Available on crate feature NSURLCredentialStorage only.

Setter for URLCredentialStorage.

pub fn URLCache(&self) -> Option<Retained<NSURLCache>>

Available on crate feature NSURLCache only.

pub fn setURLCache(&self, url_cache: Option<&NSURLCache>)

Available on crate feature NSURLCache only.

Setter for URLCache.

pub fn shouldUseExtendedBackgroundIdleMode(&self) -> bool

👎Deprecated: Not supported

pub fn setShouldUseExtendedBackgroundIdleMode( &self, should_use_extended_background_idle_mode: bool, )

👎Deprecated: Not supported

Setter for shouldUseExtendedBackgroundIdleMode.

pub fn protocolClasses(&self) -> Option<Retained<NSArray<AnyClass>>>

Available on crate feature NSArray only.

pub unsafe fn setProtocolClasses( &self, protocol_classes: Option<&NSArray<AnyClass>>, )

Available on crate feature NSArray only.

Setter for protocolClasses.

This is copied when set.

Safety

protocol_classes generic probably has further requirements.

pub fn multipathServiceType(&self) -> NSURLSessionMultipathServiceType

pub fn setMultipathServiceType( &self, multipath_service_type: NSURLSessionMultipathServiceType, )

Setter for multipathServiceType.

pub fn usesClassicLoadingMode(&self) -> bool

pub fn setUsesClassicLoadingMode(&self, uses_classic_loading_mode: bool)

Setter for usesClassicLoadingMode.

pub fn enablesEarlyData(&self) -> bool

pub fn setEnablesEarlyData(&self, enables_early_data: bool)

Setter for enablesEarlyData.

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

👎Deprecated: Please use NSURLSessionConfiguration.defaultSessionConfiguration or other class methods to create instances

pub fn new() -> Retained<Self>

👎Deprecated: Please use NSURLSessionConfiguration.defaultSessionConfiguration or other class methods to create instances

impl NSURLSessionConfiguration

NSURLSessionDeprecated.

pub fn backgroundSessionConfiguration( identifier: &NSString, ) -> Retained<NSURLSessionConfiguration>

👎Deprecated

Available on crate feature NSString 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 NSURLSessionConfiguration

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSURLSessionConfiguration

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSURLSessionConfiguration> for NSURLSessionConfiguration

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSURLSessionConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSURLSessionConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSURLSessionConfiguration

const NAME: &'static str = "NSURLSessionConfiguration"

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

type Super = NSObject

The superclass of this class.

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

Available on crate feature NSObject only.

type Result = NSURLSessionConfiguration

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

impl Debug for NSURLSessionConfiguration

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

Formats the value using the given formatter.

impl Deref for NSURLSessionConfiguration

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSURLSessionConfiguration

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 NSURLSessionConfiguration

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for NSURLSessionConfiguration

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 NSURLSessionConfiguration

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 NSURLSessionConfiguration

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 NSURLSessionConfiguration

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

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

impl DowncastTarget for NSURLSessionConfiguration

impl Eq for NSURLSessionConfiguration

impl Send for NSURLSessionConfiguration

impl Sync for NSURLSessionConfiguration