Struct CKOperation

Source

pub struct CKOperation { /* private fields */ }

Available on crate feature CKOperation only.

Expand description

Apple’s documentation

Implementations§

Source §

impl CKOperation

Source

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

Source

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

This defines per-operation configuration settings.

See the CKOperationConfiguration class description for info on how this configuration composes with CKOperationGroup.defaultConfiguration

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn setConfiguration( &self, configuration: Option<&CKOperationConfiguration>, )

Setter for configuration.

This is copied when set.

§Safety

This might not be thread-safe.

Source

pub unsafe fn group(&self) -> Option<Retained<CKOperationGroup>>

Available on crate feature CKOperationGroup only.

The group this operation is associated with

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn setGroup(&self, group: Option<&CKOperationGroup>)

Available on crate feature CKOperationGroup only.

Setter for group.

§Safety

This might not be thread-safe.

Source

pub unsafe fn operationID(&self) -> Retained<CKOperationID>

This is an identifier unique to this CKOperation.

This value is chosen by the system, and will be unique to this instance of a CKOperation. This identifier will be sent to Apple’s servers, and can be used to identify any server-side logging associated with this operation.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn longLivedOperationWasPersistedBlock( &self, ) -> *mut DynBlock<dyn Fn()>

Available on crate feature block2 only.

This callback is called after a long lived operation has begun running and is persisted.

Once this callback is called the operation will continue running even if the current process exits. Each CKOperationinstance has a private serial queue. This queue is used for all callback block invocations. This block may share mutable state with other blocks assigned to this operation, but any such mutable state should not be concurrently used outside of blocks assigned to this operation.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn setLongLivedOperationWasPersistedBlock( &self, long_lived_operation_was_persisted_block: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

Setter for longLivedOperationWasPersistedBlock.

This is copied when set.

§Safety

This might not be thread-safe.

Source §

impl CKOperation

Methods declared on superclass NSObject.

Source

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

Source §

impl CKOperation

CKOperationDeprecated.

These deprecated properties now read and write from the CKOperation’s configuration

Source

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

👎Deprecated: Use CKOperationConfiguration

Available on crate feature CKContainer only.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

👎Deprecated: Use CKOperationConfiguration

Available on crate feature CKContainer only.

Setter for container.

§Safety

This might not be thread-safe.

Source

pub unsafe fn allowsCellularAccess(&self) -> bool

👎Deprecated: Use CKOperationConfiguration

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

👎Deprecated: Use CKOperationConfiguration

Setter for allowsCellularAccess.

§Safety

This might not be thread-safe.

Source

pub unsafe fn isLongLived(&self) -> bool

👎Deprecated: Use CKOperationConfiguration

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

👎Deprecated: Use CKOperationConfiguration

Setter for isLongLived.

§Safety

This might not be thread-safe.

Source

pub unsafe fn timeoutIntervalForRequest(&self) -> NSTimeInterval

👎Deprecated: Use CKOperationConfiguration

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

👎Deprecated: Use CKOperationConfiguration

Setter for timeoutIntervalForRequest.

§Safety

This might not be thread-safe.

Source

pub unsafe fn timeoutIntervalForResource(&self) -> NSTimeInterval

👎Deprecated: Use CKOperationConfiguration

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

👎Deprecated: Use CKOperationConfiguration

Setter for timeoutIntervalForResource.

§Safety

This might not be thread-safe.

Methods from Deref<Target = NSOperation>§

Source

pub unsafe fn completionBlock(&self) -> *mut Block<dyn Fn()>

§Safety

The returned block must be sendable.

Source

pub unsafe fn setCompletionBlock( &self, completion_block: Option<&Block<dyn Fn()>>, )

Setter for completionBlock.

This is copied when set.

§Safety

completion_block block must be sendable.

Source

pub fn waitUntilFinished(&self)

Source

pub fn threadPriority(&self) -> f64

👎Deprecated: Not supported

Source

pub fn setThreadPriority(&self, thread_priority: f64)

👎Deprecated: Not supported

Setter for threadPriority.

Source

pub fn qualityOfService(&self) -> NSQualityOfService

Source

pub fn setQualityOfService(&self, quality_of_service: NSQualityOfService)

Setter for qualityOfService.

Source

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

Source

pub fn setName(&self, name: Option<&NSString>)

Setter for name.

This is copied when set.

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

Trait Implementations§

Source §