Struct MLCLayer

Source

pub struct MLCLayer { /* private fields */ }

👎Deprecated

Available on crate feature MLCLayer only.

Expand description

The base class for all MLCompute layers

There are as many MLCLayer subclasses as there are MLCompute neural network layer objects. Make one of those. This class defines an polymorphic interface for them.

Implementations§

Source §

impl MLCLayer

Source

pub unsafe fn layerID(&self) -> NSUInteger

👎Deprecated

The layer ID

A unique number to identify each layer. Assigned when the layer is created.

Source

pub unsafe fn label(&self) -> Retained<NSString>

👎Deprecated

A string to help identify this object.

Source

pub unsafe fn setLabel(&self, label: &NSString)

👎Deprecated

Setter for label.

This is copied when set.

Source

pub unsafe fn isDebuggingEnabled(&self) -> bool

👎Deprecated

A flag to identify if we want to debug this layer when executing a graph that includes this layer

If this is set, we will make sure that the result tensor and gradient tensors are available for reading on CPU The default is NO. If isDebuggingEnabled is set to YES, make sure to set options to enable debugging when compiling the graph. Otherwise this property may be ignored.

Source

pub unsafe fn setIsDebuggingEnabled(&self, is_debugging_enabled: bool)

👎Deprecated

Setter for isDebuggingEnabled.

Source

pub unsafe fn supportsDataType_onDevice( data_type: MLCDataType, device: &MLCDevice, ) -> bool

👎Deprecated

Available on crate features MLCDevice and MLCTypes only.

Determine whether instances of this layer accept source tensors of the given data type on the given device.

Parameter dataType: A data type of a possible input tensor to the layer

Parameter device: A device

Returns: A boolean indicating whether the data type is supported

Source

pub unsafe fn deviceType(&self) -> MLCDeviceType

Available on crate feature MLCTypes only.

The device type where this layer will be executed

Typically the MLCDevice passed to compileWithOptions will be the device used to execute layers in the graph. If MLCDeviceTypeANE is selected, it is possible that some of the layers of the graph may not be executed on the ANE but instead on the CPU or GPU. This property can be used to determine which device type the layer will be executed on.

Source

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

👎Deprecated

Source

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

👎Deprecated

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 §