Struct AVAssetResourceLoadingRequest

Source

pub struct AVAssetResourceLoadingRequest { /* private fields */ }

Available on crate feature AVAssetResourceLoader only.

Expand description

Apple’s documentation

Implementations§

Source §

pub unsafe fn request(&self) -> Retained<NSURLRequest>

An NSURLRequest for the requested resource.

Source

pub unsafe fn isFinished(&self) -> bool

Indicates whether loading of the resource has been finished.

The value of this property becomes YES only in response to an invocation of either -finishLoading or -finishLoadingWithError:.

Source

pub unsafe fn isCancelled(&self) -> bool

Indicates whether the request has been cancelled.

The value of this property becomes YES when the resource loader cancels the loading of a request, just prior to sending the message -resourceLoader:didCancelLoadingRequest: to its delegate.

Source

pub unsafe fn contentInformationRequest( &self, ) -> Option<Retained<AVAssetResourceLoadingContentInformationRequest>>

An instance of AVAssetResourceLoadingContentInformationRequest that you must populate with information about the resource before responding to any AVAssetResourceLoadingDataRequests for the resource. The value of this property will be nil if no such information is being requested.

Source

pub unsafe fn dataRequest( &self, ) -> Option<Retained<AVAssetResourceLoadingDataRequest>>

An instance of AVAssetResourceLoadingDataRequest that indicates the range of resource data that’s being requested. If an AVAssetResourceLoadingContentInformationRequest has been provided, you must set its properties appropriately before responding to any AVAssetResourceLoadingDataRequests. The value of this property will be nil if no data is being requested.

Source

pub unsafe fn response(&self) -> Option<Retained<NSURLResponse>>

Set the value of this property to an instance of NSURLResponse indicating a response to the loading request. If no response is needed, leave the value of this property set to nil.

Source

pub unsafe fn setResponse(&self, response: Option<&NSURLResponse>)

Setter for response.

This is copied when set.

Source

pub unsafe fn redirect(&self) -> Option<Retained<NSURLRequest>>

Set the value of this property to an instance of NSURLRequest indicating a redirection of the loading request to another URL. If no redirection is needed, leave the value of this property set to nil.

AVAssetResourceLoader supports redirects to HTTP URLs only. Redirects to other URLs will result in a loading failure.

Source

pub unsafe fn setRedirect(&self, redirect: Option<&NSURLRequest>)

Setter for redirect.

This is copied when set.

Source

pub unsafe fn requestor(&self) -> Retained<AVAssetResourceLoadingRequestor>

The AVAssetResourceLoadingRequestor that made this request

Source

pub unsafe fn finishLoading(&self)

Causes the receiver to treat the processing of the request as complete.

If a dataRequest is present, and the resource does not contain the full extent of the data that has been requested according to the values of the requestedOffset and requestedLength properties of the dataRequest, or if requestsAllDataToEndOfResource has a value of YES, -finishLoading may be invoked after providing as much of the requested data as the resource contains. If the contentInformationRequest property is not nil and specifies a non-empty allowedContentTypes array, the contentInformationRequest’s contentType property must be set to a value within allowedContentTypes. Otherwise, this method will throw an exception.

Source

pub unsafe fn finishLoadingWithError(&self, error: Option<&NSError>)

Causes the receiver to treat the request as having failed.

Parameter error: An instance of NSError indicating the reason for failure.

Source §

impl AVAssetResourceLoadingRequest

AVAssetResourceLoadingRequestContentKeyRequestSupport.

Source

pub unsafe fn streamingContentKeyRequestDataForApp_contentIdentifier_options_error( &self, app_identifier: &NSData, content_identifier: &NSData, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Result<Retained<NSData>, Retained<NSError>>

👎Deprecated: Use -[AVContentKeyRequest makeStreamingContentKeyRequestDataForApp:contentIdentifier:options:completionHandler:] instead

Obtains a streaming content key request for a specific combination of application and content.

Parameter appIdentifier: An opaque identifier for the application. The value of this identifier depends on the particular system used to provide the decryption key.

Parameter contentIdentifier: An opaque identifier for the content. The value of this identifier depends on the particular system used to provide the decryption key.

Parameter options: Additional information necessary to obtain the key, or nil if none.

Parameter outError: If obtaining the streaming content key request fails, will be set to an instance of NSError describing the failure.

Returns: The key request data that must be transmitted to the key vendor to obtain the content key.

§Safety

options generic should be of the correct type.

Source

pub unsafe fn persistentContentKeyFromKeyVendorResponse_options_error( &self, key_vendor_response: &NSData, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Result<Retained<NSData>, Retained<NSError>>

👎Deprecated: Use -[AVPersistableContentKeyRequest persistableContentKeyFromKeyVendorResponse:options:error:] instead

Obtains a persistable content key from a context.

Parameter keyVendorResponse: The response returned from the key vendor as a result of a request generated from streamingContentKeyRequestDataForApp:contentIdentifier:options:error:.

Parameter options: Additional information necessary to obtain the persistable content key, or nil if none.

Parameter outError: If obtaining the persistable content key fails, will be set to an instance of NSError describing the failure.

Returns: The persistable content key data that may be stored offline to answer future loading requests of the same content key.

The data returned from this method may be used to immediately satisfy an AVAssetResourceLoadingDataRequest, as well as any subsequent requests for the same key url. The value of AVAssetResourceLoadingContentInformationRequest.contentType must be set to AVStreamingKeyDeliveryPersistentContentKeyType when responding with data created with this method.

§Safety

options generic should be of the correct type.

Source §

impl AVAssetResourceLoadingRequest

AVAssetResourceLoadingRequestDeprecated.

Source

pub unsafe fn finishLoadingWithResponse_data_redirect( &self, response: Option<&NSURLResponse>, data: Option<&NSData>, redirect: Option<&NSURLRequest>, )

👎Deprecated: Use -[AVAssetResourceLoadingRequest setResponse:], -[AVAssetResourceLoadingRequest setRedirect:], -[AVAssetResourceLoadingDataRequest respondWithData:], -[AVAssetResourceLoadingRequest finishLoading]

Causes the receiver to finish loading a resource that a delegate has previously assumed responsibility for loading by returning YES as the result of -resourceLoader:shouldWaitForLoadingOfRequestedResource:.

Parameter response: The NSURLResponse for the NSURLRequest of the receiver. Should be nil if no response is required.

Parameter data: An instance of NSData containing the data of the resource. Should be nil if no such data is available.

Parameter redirect: An instance of NSURLRequest indicating a redirect of the loading request. Should be nil if no redirect is needed.

This method is deprecated. Use the following methods instead. -[AVAssetResourceLoadingRequest setResponse:] to set the response property, -[AVAssetResourceLoadingRequest setRedirect:] to set the redirect property, -[AVAssetResourceLoadingDataRequest respondWithData:] to provide data, and -[AVAssetResourceLoadingRequest finishLoading] to indicate that loading is finished.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}