Struct NSURLSession

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

Available on crate feature NSURLSession only.

Apple’s documentation

Implementations

impl NSURLSession

pub unsafe fn sharedSession() -> Retained<NSURLSession>

pub unsafe fn sessionWithConfiguration( configuration: &NSURLSessionConfiguration, ) -> Retained<NSURLSession>

pub unsafe fn sessionWithConfiguration_delegate_delegateQueue( configuration: &NSURLSessionConfiguration, delegate: Option<&ProtocolObject<dyn NSURLSessionDelegate>>, queue: Option<&NSOperationQueue>, ) -> Retained<NSURLSession>

Available on crate feature NSOperation only.

pub unsafe fn delegateQueue(&self) -> Retained<NSOperationQueue>

Available on crate feature NSOperation only.

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn NSURLSessionDelegate>>>

pub unsafe fn configuration(&self) -> Retained<NSURLSessionConfiguration>

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

Available on crate feature NSString only.

pub unsafe fn setSessionDescription( &self, session_description: Option<&NSString>, )

Available on crate feature NSString only.

Setter for sessionDescription.

pub unsafe fn finishTasksAndInvalidate(&self)

pub unsafe fn invalidateAndCancel(&self)

pub unsafe fn resetWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn()>, )

Available on crate feature block2 only.

pub unsafe fn flushWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn()>, )

Available on crate feature block2 only.

pub unsafe fn getTasksWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(NonNull<NSArray<NSURLSessionDataTask>>, NonNull<NSArray<NSURLSessionUploadTask>>, NonNull<NSArray<NSURLSessionDownloadTask>>)>, )

Available on crate features NSArray and block2 only.

pub unsafe fn getAllTasksWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(NonNull<NSArray<NSURLSessionTask>>)>, )

Available on crate features NSArray and block2 only.

pub unsafe fn dataTaskWithRequest( &self, request: &NSURLRequest, ) -> Retained<NSURLSessionDataTask>

Available on crate feature NSURLRequest only.

pub unsafe fn dataTaskWithURL( &self, url: &NSURL, ) -> Retained<NSURLSessionDataTask>

Available on crate feature NSURL only.

pub unsafe fn uploadTaskWithRequest_fromFile( &self, request: &NSURLRequest, file_url: &NSURL, ) -> Retained<NSURLSessionUploadTask>

Available on crate features NSURL and NSURLRequest only.

pub unsafe fn uploadTaskWithRequest_fromData( &self, request: &NSURLRequest, body_data: &NSData, ) -> Retained<NSURLSessionUploadTask>

Available on crate features NSData and NSURLRequest only.

pub unsafe fn uploadTaskWithResumeData( &self, resume_data: &NSData, ) -> Retained<NSURLSessionUploadTask>

Available on crate feature NSData only.

Creates an upload task from a resume data blob. Requires the server to support the latest resumable uploads Internet-Draft from the HTTP Working Group, found at https://datatracker.ietf.org/doc/draft-ietf-httpbis-resumable-upload/ If resuming from an upload file, the file must still exist and be unmodified. If the upload cannot be successfully resumed, URLSession:task:didCompleteWithError: will be called.

• Parameter resumeData: Resume data blob from an incomplete upload, such as data returned by the cancelByProducingResumeData: method.
• Returns: A new session upload task, or nil if the resumeData is invalid.

pub unsafe fn uploadTaskWithStreamedRequest( &self, request: &NSURLRequest, ) -> Retained<NSURLSessionUploadTask>

Available on crate feature NSURLRequest only.

pub unsafe fn downloadTaskWithRequest( &self, request: &NSURLRequest, ) -> Retained<NSURLSessionDownloadTask>

Available on crate feature NSURLRequest only.

pub unsafe fn downloadTaskWithURL( &self, url: &NSURL, ) -> Retained<NSURLSessionDownloadTask>

Available on crate feature NSURL only.

pub unsafe fn downloadTaskWithResumeData( &self, resume_data: &NSData, ) -> Retained<NSURLSessionDownloadTask>

Available on crate feature NSData only.

pub unsafe fn streamTaskWithHostName_port( &self, hostname: &NSString, port: NSInteger, ) -> Retained<NSURLSessionStreamTask>

Available on crate feature NSString only.

pub unsafe fn streamTaskWithNetService( &self, service: &NSNetService, ) -> Retained<NSURLSessionStreamTask>

👎Deprecated: Use nw_connection_t in Network framework instead

Available on crate feature NSNetServices only.

pub unsafe fn webSocketTaskWithURL( &self, url: &NSURL, ) -> Retained<NSURLSessionWebSocketTask>

Available on crate feature NSURL only.

pub unsafe fn webSocketTaskWithURL_protocols( &self, url: &NSURL, protocols: &NSArray<NSString>, ) -> Retained<NSURLSessionWebSocketTask>

Available on crate features NSArray and NSString and NSURL only.

pub unsafe fn webSocketTaskWithRequest( &self, request: &NSURLRequest, ) -> Retained<NSURLSessionWebSocketTask>

Available on crate feature NSURLRequest only.

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

👎Deprecated: Please use +[NSURLSession sessionWithConfiguration:] or other class methods to create instances

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

👎Deprecated: Please use +[NSURLSession sessionWithConfiguration:] or other class methods to create instances

impl NSURLSession

NSURLSessionAsynchronousConvenience.

pub unsafe fn dataTaskWithRequest_completionHandler( &self, request: &NSURLRequest, completion_handler: &DynBlock<dyn Fn(*mut NSData, *mut NSURLResponse, *mut NSError)>, ) -> Retained<NSURLSessionDataTask>

Available on crate features NSData and NSError and NSURLRequest and NSURLResponse and block2 only.

pub unsafe fn dataTaskWithURL_completionHandler( &self, url: &NSURL, completion_handler: &DynBlock<dyn Fn(*mut NSData, *mut NSURLResponse, *mut NSError)>, ) -> Retained<NSURLSessionDataTask>

Available on crate features NSData and NSError and NSURL and NSURLResponse and block2 only.

pub unsafe fn uploadTaskWithRequest_fromFile_completionHandler( &self, request: &NSURLRequest, file_url: &NSURL, completion_handler: &DynBlock<dyn Fn(*mut NSData, *mut NSURLResponse, *mut NSError)>, ) -> Retained<NSURLSessionUploadTask>

Available on crate features NSData and NSError and NSURL and NSURLRequest and NSURLResponse and block2 only.

pub unsafe fn uploadTaskWithRequest_fromData_completionHandler( &self, request: &NSURLRequest, body_data: Option<&NSData>, completion_handler: &DynBlock<dyn Fn(*mut NSData, *mut NSURLResponse, *mut NSError)>, ) -> Retained<NSURLSessionUploadTask>

Available on crate features NSData and NSError and NSURLRequest and NSURLResponse and block2 only.

pub unsafe fn uploadTaskWithResumeData_completionHandler( &self, resume_data: &NSData, completion_handler: &DynBlock<dyn Fn(*mut NSData, *mut NSURLResponse, *mut NSError)>, ) -> Retained<NSURLSessionUploadTask>

Available on crate features NSData and NSError and NSURLResponse and block2 only.

Creates a URLSessionUploadTask from a resume data blob. If resuming from an upload file, the file must still exist and be unmodified.

• Parameter resumeData: Resume data blob from an incomplete upload, such as data returned by the cancelByProducingResumeData: method.
• Parameter completionHandler: The completion handler to call when the load request is complete.
• Returns: A new session upload task, or nil if the resumeData is invalid.

pub unsafe fn downloadTaskWithRequest_completionHandler( &self, request: &NSURLRequest, completion_handler: &DynBlock<dyn Fn(*mut NSURL, *mut NSURLResponse, *mut NSError)>, ) -> Retained<NSURLSessionDownloadTask>

Available on crate features NSError and NSURL and NSURLRequest and NSURLResponse and block2 only.

pub unsafe fn downloadTaskWithURL_completionHandler( &self, url: &NSURL, completion_handler: &DynBlock<dyn Fn(*mut NSURL, *mut NSURLResponse, *mut NSError)>, ) -> Retained<NSURLSessionDownloadTask>

Available on crate features NSError and NSURL and NSURLResponse and block2 only.

pub unsafe fn downloadTaskWithResumeData_completionHandler( &self, resume_data: &NSData, completion_handler: &DynBlock<dyn Fn(*mut NSURL, *mut NSURLResponse, *mut NSError)>, ) -> Retained<NSURLSessionDownloadTask>

Available on crate features NSData and NSError and NSURL and NSURLResponse 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 NSURLSession

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSURLSession

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSURLSession> for NSURLSession

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSURLSession

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSURLSession

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSURLSession

const NAME: &'static str = "NSURLSession"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for NSURLSession

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSURLSession

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 NSURLSession

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for NSURLSession

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 NSURLSession

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 NSURLSession

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

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

impl DowncastTarget for NSURLSession

impl Eq for NSURLSession

impl Send for NSURLSession

impl Sync for NSURLSession