Struct MPSGraphCompilationDescriptor

Source

pub struct MPSGraphCompilationDescriptor { /* private fields */ }

Available on crate features MPSGraph and MPSGraphCore only.

Expand description

A class that consists of all the levers for compiling graphs.

Implementations§

Source §

impl MPSGraphCompilationDescriptor

Source

pub unsafe fn disableTypeInference(&self)

Turns off type inference and relies on type inference during runtime.

Source

pub unsafe fn optimizationLevel(&self) -> MPSGraphOptimization

The optimization level for the graph execution, default is MPSGraphOptimizationLevel1.

Source

pub unsafe fn setOptimizationLevel( &self, optimization_level: MPSGraphOptimization, )

Setter for optimizationLevel.

Source

pub unsafe fn waitForCompilationCompletion(&self) -> bool

Flag that makes the compile or specialize call blocking till the entire compilation is complete, defaults to NO.

Source

pub unsafe fn setWaitForCompilationCompletion( &self, wait_for_compilation_completion: bool, )

Setter for waitForCompilationCompletion.

Source

pub unsafe fn compilationCompletionHandler( &self, ) -> MPSGraphCompilationCompletionHandler

Available on crate features MPSGraphExecutable and block2 only.

The handler that the graph calls when the compilation completes.

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 setCompilationCompletionHandler( &self, compilation_completion_handler: MPSGraphCompilationCompletionHandler, )

Available on crate features MPSGraphExecutable and block2 only.

Setter for compilationCompletionHandler.

§Safety

compilation_completion_handler must be a valid pointer.

Source

pub unsafe fn dispatchQueue(&self) -> Retained<DispatchQueue>

Available on crate feature dispatch2 only.

The dispatch queue used for the compilation.

Default value is nil.

Source

pub unsafe fn setDispatchQueue(&self, dispatch_queue: &DispatchQueue)

Available on crate feature dispatch2 only.

Setter for dispatchQueue.

§Safety

dispatch_queue possibly has additional threading requirements.

Source

pub unsafe fn optimizationProfile(&self) -> MPSGraphOptimizationProfile

👎Deprecated

The optimization profile for the graph optimization.

Default is MPSGraphOptimizationProfilePerformance.

Source

pub unsafe fn setOptimizationProfile( &self, optimization_profile: MPSGraphOptimizationProfile, )

👎Deprecated

Setter for optimizationProfile.

Source

pub unsafe fn callables(&self) -> Option<Retained<MPSGraphCallableMap>>

Available on crate feature MPSGraphExecutable only.

The dictionary used during runtime to lookup the MPSGraphExecutable which correspond to the symbolName.

Source

pub unsafe fn setCallables(&self, callables: Option<&MPSGraphCallableMap>)

Available on crate feature MPSGraphExecutable only.

Setter for callables.

Source

pub unsafe fn reducedPrecisionFastMath( &self, ) -> MPSGraphReducedPrecisionFastMath

Across the executable allow reduced precision fast math optimizations.

Source

pub unsafe fn setReducedPrecisionFastMath( &self, reduced_precision_fast_math: MPSGraphReducedPrecisionFastMath, )

Setter for reducedPrecisionFastMath.

Source §

impl MPSGraphCompilationDescriptor

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