Struct AVAssetDownloadURLSession

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

Available on crate feature AVAssetDownloadTask only.

A subclass of NSURLSession to support AVAssetDownloadTask.

See also Apple’s documentation

Implementations

impl AVAssetDownloadURLSession

pub unsafe fn sessionWithConfiguration_assetDownloadDelegate_delegateQueue( configuration: &NSURLSessionConfiguration, delegate: Option<&ProtocolObject<dyn AVAssetDownloadDelegate>>, delegate_queue: Option<&NSOperationQueue>, ) -> Retained<AVAssetDownloadURLSession>

Creates and initializes an AVAssetDownloadURLSession for use with AVAssetDownloadTasks.

Parameter configuration: The configuration for this URLSession. Must be a background configuration.

Parameter delegate: The delegate object to handle asset download progress updates and other session related events.

Parameter delegateQueue: The queue to receive delegate callbacks on. If nil, a serial queue will be provided.

pub unsafe fn assetDownloadTaskWithURLAsset_destinationURL_options( &self, url_asset: &AVURLAsset, destination_url: &NSURL, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Option<Retained<AVAssetDownloadTask>>

👎Deprecated: Use assetDownloadTaskWithURLAsset:assetTitle:assetArtworkData:options: instead

Available on crate feature AVAsset only.

Creates and initializes an AVAssetDownloadTask to be used with this AVAssetDownloadURLSession.

This method may return nil if the URLSession has been invalidated.

Parameter URLAsset: The AVURLAsset to download locally.

Parameter destinationURL: The local URL to download the asset to. This must be a file URL.

Parameter options: See AVAssetDownloadTask*Key above. Configures non-default behavior for the download task. Using this parameter is required for downloading non-default media selections for HLS assets.

pub unsafe fn assetDownloadTaskWithURLAsset_assetTitle_assetArtworkData_options( &self, url_asset: &AVURLAsset, title: &NSString, artwork_data: Option<&NSData>, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Option<Retained<AVAssetDownloadTask>>

👎Deprecated: Use assetDownloadTaskWithConfiguration: instead

Available on crate feature AVAsset only.

Creates and initializes an AVAssetDownloadTask to be used with this AVAssetDownloadURLSession.

This method may return nil if the URLSession has been invalidated.

Parameter URLAsset: The AVURLAsset to download locally.

Parameter title: A human readable title for this asset, expected to be as suitable as possible for the user’s preferred languages. Will show up in the usage pane of the settings app.

Parameter artworkData: NSData representing artwork data for this asset. Optional. Will show up in the usage pane of the settings app. Must work with +[UIImage imageWithData:].

Parameter options: See AVAssetDownloadTask*Key above. Configures non-default behavior for the download task. Using this parameter is required for downloading non-default media selections for HLS assets.

pub unsafe fn aggregateAssetDownloadTaskWithURLAsset_mediaSelections_assetTitle_assetArtworkData_options( &self, url_asset: &AVURLAsset, media_selections: &NSArray<AVMediaSelection>, title: &NSString, artwork_data: Option<&NSData>, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Option<Retained<AVAggregateAssetDownloadTask>>

👎Deprecated: Use assetDownloadTaskWithConfiguration: instead

Available on crate features AVAsset and AVMediaSelection only.

Creates and initializes an AVAggregateAssetDownloadTask to download multiple AVMediaSelections on an AVURLAsset.

This method may return nil if the URLSession has been invalidated. The value of AVAssetDownloadTaskMediaSelectionKey will be ignored.

Parameter URLAsset: The AVURLAsset to download locally.

Parameter mediaSelections: A list of AVMediaSelections. Each AVMediaSelection will correspond to a childAssetDownloadTask. Use -[AVAsset allMediaSelections] to download all AVMediaSelections on this AVAsset.

Parameter title: A human readable title for this asset, expected to be as suitable as possible for the user’s preferred languages. Will show up in the usage pane of the settings app.

Parameter artworkData: Artwork data for this asset. Optional. Will show up in the usage pane of the settings app.

Parameter options: See AVAssetDownloadTask*Key above. Configures non-default behavior for the download task.

pub unsafe fn assetDownloadTaskWithConfiguration( &self, download_configuration: &AVAssetDownloadConfiguration, ) -> Retained<AVAssetDownloadTask>

Creates and initializes an AVAssetDownloadTask to be used with this AVAssetDownloadURLSession.

This method will throw an exception if the URLSession has been invalidated.

Parameter downloadConfiguration: The configuration to be used to create the download task.

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

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

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>

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

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

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

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

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

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

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

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

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

Methods from Deref<Target = NSURLSession>

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 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: isize, ) -> Retained<NSURLSessionStreamTask>

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

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.

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<AVAssetDownloadURLSession> for AVAssetDownloadURLSession

fn as_ref(&self) -> &Self

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

impl AsRef<AnyObject> for AVAssetDownloadURLSession

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for AVAssetDownloadURLSession

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSURLSession> for AVAssetDownloadURLSession

fn as_ref(&self) -> &NSURLSession

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

impl Borrow<AnyObject> for AVAssetDownloadURLSession

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for AVAssetDownloadURLSession

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSURLSession> for AVAssetDownloadURLSession

fn borrow(&self) -> &NSURLSession

Immutably borrows from an owned value.

impl ClassType for AVAssetDownloadURLSession

const NAME: &'static str = "AVAssetDownloadURLSession"

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

type Super = NSURLSession

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for AVAssetDownloadURLSession

type Target = NSURLSession

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for AVAssetDownloadURLSession

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 AVAssetDownloadURLSession

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for AVAssetDownloadURLSession

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 AVAssetDownloadURLSession

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 AVAssetDownloadURLSession

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

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

impl DowncastTarget for AVAssetDownloadURLSession

impl Eq for AVAssetDownloadURLSession