Struct CKOperationConfiguration 

pub struct CKOperationConfiguration { /* private fields */ }

Available on crate feature CKOperation only.

An operation configuration is a set of properties that describes how your operation should behave. All properties have a default value. When determining what properties to apply to an operation, we consult the operation’s configuration property, as well as the operation->group->defaultConfiguration property. We combine them following these rules:

   Group Default Configuration Value | Operation Configuration Value |        Value Applied To Operation
  -----------------------------------+-------------------------------+-----------------------------------------
             default value           |         default value         |                  default value
             default value           |         explicit value        |       operation.configuration explicit value
             explicit value          |         default value         | operation.group.defaultConfiguration explicit value
             explicit value          |         explicit value        |       operation.configuration explicit value

For example: CKOperationGroup -> defaultConfiguration -> allowsCellularAccess explicitly set to NO

• CKOperation -> configuration -> allowsCellularAccess has default value of YES = disallow cellular access

CKOperationGroup -> defaultConfiguration -> allowsCellularAccess explicitly set to NO

• CKOperation -> configuration -> allowsCellularAccess explicitly set to YES = allow cellular access

See also Apple’s documentation

Implementations

impl CKOperationConfiguration

pub unsafe fn container(&self) -> Option<Retained<CKContainer>>

Available on crate feature CKContainer only.

If no container is set, [CKContainer defaultContainer] is used

pub unsafe fn setContainer(&self, container: Option<&CKContainer>)

Available on crate feature CKContainer only.

Setter for container.

pub unsafe fn qualityOfService(&self) -> NSQualityOfService

CKOperations behave differently depending on how you set qualityOfService.

  Quality of Service | timeoutIntervalForResource | Network Error Behavior | Discretionary Behavior
  -------------------+----------------------------+------------------------+-----------------------
  UserInteractive    | -1 (no enforcement)        | fail                   | nonDiscretionary
  UserInitiated      | -1 (no enforcement)        | fail                   | nonDiscretionary
  Default            | 1 week                     | fail                   | discretionary when app backgrounded
  Utility            | 1 week                     | internally retried     | discretionary when app backgrounded
  Background         | 1 week                     | internally retried     | discretionary

timeoutIntervalForResource

• the timeout interval for any network resources retrieved by this operation
• this can be overridden via CKOperationConfiguration’s timeoutIntervalForResource property

Network Error Behavior

• when a network request in service of a CKOperation fails due to a networking error, the operation may fail with that error, or internally retry the network request. Only a subset of networking errors are retried, and limiting factors such as timeoutIntervalForResource are still applicable.

Discretionary Behavior

• network requests in service of a CKOperation may be marked as discretionary
• discretionary network requests are scheduled at the description of the system for optimal performance

CKOperations have a default qualityOfService of Default.

pub unsafe fn setQualityOfService(&self, quality_of_service: NSQualityOfService)

Setter for qualityOfService.

pub unsafe fn allowsCellularAccess(&self) -> bool

Defaults to YES

pub unsafe fn setAllowsCellularAccess(&self, allows_cellular_access: bool)

Setter for allowsCellularAccess.

pub unsafe fn isLongLived(&self) -> bool

Long lived operations will continue running even if your process exits. If your process remains alive for the lifetime of the long lived operation its behavior is the same as a regular operation.

Long lived operations can be fetched and replayed from the container via the fetchAllLongLivedOperations:and fetchLongLivedOperationsWithIDs:APIs. Your code should only fetch and re-enqueue long lived operations on app launch.

Long lived operations persist until their -[NSOperation completionBlock] returns or until the operation is cancelled. Long lived operations may be garbage collected 24 hours after they finish running if no client has replayed them.

The default value for longLived is NO. Changing the value of longLived on an already started operation or on an outstanding long lived operation fetched from CKContainer has no effect.

pub unsafe fn setLongLived(&self, long_lived: bool)

Setter for isLongLived.

pub unsafe fn timeoutIntervalForRequest(&self) -> NSTimeInterval

If non-zero, overrides the timeout interval for any network requests issued by this operation. The default value is 60.

See: NSURLSessionConfiguration.timeoutIntervalForRequest

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

Setter for timeoutIntervalForRequest.

pub unsafe fn timeoutIntervalForResource(&self) -> NSTimeInterval

If set, overrides the timeout interval for any network resources retrieved by this operation. If not explicitly set, defaults to a value based on the operation’s qualityOfService

See: NSURLSessionConfiguration.timeoutIntervalForResource

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

Setter for timeoutIntervalForResource.

impl CKOperationConfiguration

Methods declared on superclass NSObject.

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

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

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 CKOperationConfiguration

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CKOperationConfiguration> for CKOperationConfiguration

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for CKOperationConfiguration

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CKOperationConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for CKOperationConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for CKOperationConfiguration

const NAME: &'static str = "CKOperationConfiguration"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for CKOperationConfiguration

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CKOperationConfiguration

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 CKOperationConfiguration

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for CKOperationConfiguration

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 CKOperationConfiguration

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 CKOperationConfiguration

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

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

impl DowncastTarget for CKOperationConfiguration

impl Eq for CKOperationConfiguration