Struct BAURLDownload 

pub struct BAURLDownload { /* private fields */ }

Available on crate features BADownload and BAURLDownload only.

Apple’s documentation

Implementations

impl BAURLDownload

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

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

pub unsafe fn initWithIdentifier_request_fileSize_applicationGroupIdentifier( this: Allocated<Self>, identifier: &NSString, request: &NSURLRequest, file_size: NSUInteger, application_group_identifier: &NSString, ) -> Retained<Self>

Constructs a download object to represent the download of a asset located inside of the provided request. Parameter identifier: A unique identifier that is used to track the download across the app and extension.

Parameter request: The request used to perform the download. The URL provided inside of the request must be a https scheme.

Parameter fileSize: The size of the file to download. This field must be accurate in order to show the user accurate progress during app installation. If the size does not match the file being downloaded, then the download will fail.

Parameter applicationGroupIdentifier: The identifier of the application group that should used to store the finished download.

pub unsafe fn initWithIdentifier_request_essential_fileSize_applicationGroupIdentifier_priority( this: Allocated<Self>, identifier: &NSString, request: &NSURLRequest, essential: bool, file_size: NSUInteger, application_group_identifier: &NSString, priority: BADownloaderPriority, ) -> Retained<Self>

Constructs a download object to represent the download of a asset located inside of the provided request. Parameter identifier: A unique identifier that is used to track the download across the app and extension.

Parameter request: The request used to perform the download. The URL provided inside of the request must be a https scheme.

Parameter essential: Whether the download is essential. See BADownload.isEssential.Default is false.

Parameter fileSize: The size of the file to download. This field must be accurate in order to show the user accurate progress during app installation. If the size does not match the file being downloaded, then the download will fail.

Parameter applicationGroupIdentifier: The identifier of the application group that should used to store the finished download.

Parameter priority: A priority between BADownloaderPriorityMin- BADownloaderPriorityMaxwhich is used to order the downloads for this process. It is recommended to use BADownloaderPriorityDefaultif download priority does not matter.

pub unsafe fn initWithIdentifier_request_applicationGroupIdentifier( this: Allocated<Self>, identifier: &NSString, request: &NSURLRequest, application_group_identifier: &NSString, ) -> Retained<Self>

👎Deprecated

Constructs a download object to represent the download of a asset located inside of the provided request. Parameter identifier: A unique identifier that is used to track the download across the app and extension.

Parameter request: The request used to perform the download. The URL provided inside of the request must be a https scheme.

Parameter applicationGroupIdentifier: The identifier of the application group that should used to store the finished download.

pub unsafe fn initWithIdentifier_request_applicationGroupIdentifier_priority( this: Allocated<Self>, identifier: &NSString, request: &NSURLRequest, application_group_identifier: &NSString, priority: BADownloaderPriority, ) -> Retained<Self>

👎Deprecated

Constructs a download object to represent the download of a asset located inside of the provided request. Parameter identifier: A unique identifier that is used to track the download across the app and extension.

Parameter request: The request used to perform the download. The URL provided inside of the request must be a https scheme.

Parameter applicationGroupIdentifier: The identifier of the application group that should used to store the finished download.

Parameter priority: A priority between BADownloaderPriorityMin- BADownloaderPriorityMaxwhich is used to order the downloads for this process. It is recommended to use BADownloaderPriorityDefaultif download priority does not matter.

Methods from Deref<Target = BADownload>

pub unsafe fn state(&self) -> BADownloadState

The current state of the respresented download.

This property is not atomic.

Safety

This might not be thread-safe.

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

A client defined identifier that uniquely identifies this asset.

This property is not atomic.

Safety

This might not be thread-safe.

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

A UUID that uniquely identifies the download object.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn priority(&self) -> BADownloaderPriority

A client set priority to try to order downloads in order of importance

pub unsafe fn isEssential(&self) -> bool

Whether this download is essential. Essential downloads will occur while the app is being installed. Users cannot launch the app while these downloads are occurring. Essential downloads cannot be scheduled with BADownloadManager, they may only be scheduled from the extension with a BAContentRequest type of Update or Install. Essential downloads must have an accurate fileSize or they will fail.

pub unsafe fn copyAsNonEssential(&self) -> Retained<Self>

Copies an existing download ensuring that it has isEssential == false.

This serves as a convenience method for constructing a non-essential representation of an existing download. It is important to note that essential downloads can only be enqueued by the app extension during a content request. If an essential download fails, copyAsNonEssential can be used to create a copy with isEssential == false that can be re-queued with BADownloadManager.

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 BAURLDownload

fn as_ref(&self) -> &AnyObject

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

impl AsRef<BADownload> for BAURLDownload

fn as_ref(&self) -> &BADownload

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

impl AsRef<BAURLDownload> for BAURLDownload

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for BAURLDownload

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for BAURLDownload

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<BADownload> for BAURLDownload

fn borrow(&self) -> &BADownload

Immutably borrows from an owned value.

impl Borrow<NSObject> for BAURLDownload

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for BAURLDownload

const NAME: &'static str = "BAURLDownload"

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

type Super = BADownload

The superclass of this class.

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

type Result = BAURLDownload

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

impl Debug for BAURLDownload

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

Formats the value using the given formatter.

impl Deref for BAURLDownload

type Target = BADownload

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for BAURLDownload

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 BAURLDownload

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for BAURLDownload

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

where Self: Sized + Message + CopyingHelper,

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,

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

impl NSObjectProtocol for BAURLDownload

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 BAURLDownload

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for BAURLDownload

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 BAURLDownload

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

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

impl DowncastTarget for BAURLDownload

impl Eq for BAURLDownload

impl NSCoding for BAURLDownload

impl Send for BAURLDownload

impl Sync for BAURLDownload