Struct MPSGraphExecutionDescriptor

Source

pub struct MPSGraphExecutionDescriptor { /* private fields */ }

Available on crate features MPSGraph and MPSGraphCore only.

Expand description

A class that consists of all the levers to synchronize and schedule graph execution.

Implementations§

Source §

impl MPSGraphExecutionDescriptor

Source

pub unsafe fn scheduledHandler(&self) -> MPSGraphScheduledHandler

Available on crate features MPSGraphTensor and MPSGraphTensorData and block2 only.

The handler that graph calls when it schedules the execution.

Default value is nil.

§Safety

The returned block’s argument 1 must be a valid pointer.
The returned block’s argument 2 must be a valid pointer or null.

Source

pub unsafe fn setScheduledHandler( &self, scheduled_handler: MPSGraphScheduledHandler, )

Available on crate features MPSGraphTensor and MPSGraphTensorData and block2 only.

Setter for scheduledHandler.

§Safety

scheduled_handler must be a valid pointer.

Source

pub unsafe fn completionHandler(&self) -> MPSGraphCompletionHandler

Available on crate features MPSGraphTensor and MPSGraphTensorData and block2 only.

The handler that graph calls at the completion of the execution.

Default value is nil.

§Safety

The returned block’s argument 1 must be a valid pointer.
The returned block’s argument 2 must be a valid pointer or null.

Source

pub unsafe fn setCompletionHandler( &self, completion_handler: MPSGraphCompletionHandler, )

Available on crate features MPSGraphTensor and MPSGraphTensorData and block2 only.

Setter for completionHandler.

§Safety

completion_handler must be a valid pointer.

Source

pub unsafe fn waitUntilCompleted(&self) -> bool

The flag that blocks the execution call until the entire execution is complete.

Defaults to NO.

Source

pub unsafe fn setWaitUntilCompleted(&self, wait_until_completed: bool)

Setter for waitUntilCompleted.

Source

pub unsafe fn compilationDescriptor( &self, ) -> Option<Retained<MPSGraphCompilationDescriptor>>

The compilation descriptor for the graph.

Default value is nil.

Source

pub unsafe fn setCompilationDescriptor( &self, compilation_descriptor: Option<&MPSGraphCompilationDescriptor>, )

Setter for compilationDescriptor.

This is copied when set.

Source

pub unsafe fn waitForEvent_value( &self, event: &ProtocolObject<dyn MTLSharedEvent>, value: u64, )

Executable waits on these shared events before scheduling execution on the HW, this does not include encoding which can still continue.

Parameters:
event: shared event graph waits on.
value: value of shared event graph waits on.

Source

pub unsafe fn signalEvent_atExecutionEvent_value( &self, event: &ProtocolObject<dyn MTLSharedEvent>, execution_stage: MPSGraphExecutionStage, value: u64, )

Executable signals these shared events at execution stage and immediately proceeds.

Parameters:
event: shared event to signal.
executionStage: execution stage to signal event at.
value: value for shared event to wait on.

Source §

impl MPSGraphExecutionDescriptor

Methods declared on superclass NSObject.

Source

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

Source

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

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